diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html
index fe18ecba8ca..4f54d4cdae5 100644
--- a/Documentation/NuttxPortingGuide.html
+++ b/Documentation/NuttxPortingGuide.html
@@ -16,7 +16,7 @@
by
Gregory Nutt
- Last Update: September 8, 2007
+ Last Update: December 10, 2007
Table of Contents
@@ -88,6 +88,7 @@
4.2.4 irq_dispatch()
+5.0 NuttX File System
Appendix A: NuttX Configuration Settings
@@ -607,13 +608,8 @@
- This directory contains the NuttX filesystem.
- The NuttX filesystem is very simple; it does not involve any block drivers or
- particular filesystem (like FAT or EXT2 etc.).
- The NuttX filesystem simply supports a set a filesystem APIs
- (open(), close(), read(), write, etc.)
- and a registration mechanism that allows devices drivers to a associated with nodes
- in a file-system-like name space.
+ This directory contains the NuttX file system.
+ This file system is described below.
@@ -1144,6 +1140,56 @@ The system can be re-made subsequently by just typing make.
the appropriate, registered handling logic.
+
+
+Overview.
+ NuttX includes an optional, scalable file system.
+ This file-system may be omitted altogther; NuttX does not depend on the presence
+ of any file system.
+
+
+Pseudo Root File System.
+ Or, a simple in-memory, psuedo file system can be enabled.
+ This simple file system can be enabled setting the CONFIG_NFILE_DESCRIPTORS
+ option to a non-zero value (see Appendix A).
+ This is an in-memory file system because it does not require any
+ storage medium or block driver support.
+ Rather, file system contents are generated on-the-fly as referenced via
+ standard file system operations (open, close, read, write, etc.).
+ In this sense, the file system is psuedo file system (in the
+ same sense that the Linux /proc file system is also
+ referred to as a psuedo file system).
+
+
+
+ Any user supplied data or logic can be accessed via the psuedo-file system.
+ Built in support is provided for character and block drivers in the
+ /dev psuedo file system directory.
+
+
+Mounted File Systems
+ The simple in-memory file system can be extended my mounting block
+ devices that provide access to true file systems backed up via some
+ mass storage device.
+ NuttX supports the standard mount() command that allows
+ a block driver to be bound to a mountpoint within the psuedo file system
+ and to a a file system.
+ At present, NuttX supports only the VFAT file system.
+
+
+Comparison to Linux
+ From a programming perspective, the NuttX file system appears very similar
+ to a Linux file system.
+ However, there is a fundamental difference:
+ The NuttX root file system is a psuedo file system and true file systems may be
+ mounted in the psuedo file system.
+ In the typical Linux installation by comparison, the Linux root file system
+ is a true file system and psuedo file systems may be mounted in the true,
+ root file system.
+ The approach selected by NuttX is intended to support greater scalability
+ from the very tiny platform to the moderate platform.
+
+
@@ -1209,7 +1255,7 @@ The system can be re-made subsequently by just typing make.
CONFIG_DEBUG_NET: enable network debug output (disabled by default)
- CONFIG_DEBUG_FS: enable filesystem debug output (disabled by default)
+ CONFIG_DEBUG_FS: enable file system debug output (disabled by default)
CONFIG_DEBUG_LIB: enable C library debug output (disabled by default)
diff --git a/Documentation/NuttxUserGuide.html b/Documentation/NuttxUserGuide.html
index 8485f287c00..9e63bb0b5d4 100644
--- a/Documentation/NuttxUserGuide.html
+++ b/Documentation/NuttxUserGuide.html
@@ -21,7 +21,7 @@ User's Manual
Gregory Nutt
-Last Update: September 23, 2007
+Last Update: December 10, 2007
@@ -54,7 +54,7 @@ Gregory Nutt
Paragraph 2.8 Signal Interfaces
Paragraph 2.9 Pthread Interfaces
Paragraph 2.10 Environment Variables
- Paragraph 2.11 Filesystem Interfaces
+ Paragraph 2.11 File System Interfaces
Paragraph 2.12 Network Interfaces
@@ -5687,11 +5687,58 @@ interface of the same name.
Zero on success.
-
+
+
+Overview.
+ NuttX includes an optional, scalable file system.
+ This file-system may be omitted altogther; NuttX does not depend on the presence
+ of any file system.
+
+
+Pseudo Root File System.
+ Or, a simple in-memory, psuedo file system can be enabled.
+ This simple file system can be enabled setting the CONFIG_NFILE_DESCRIPTORS
+ option to a non-zero value.
+ This is an in-memory file system because it does not require any
+ storage medium or block driver support.
+ Rather, file system contents are generated on-the-fly as referenced via
+ standard file system operations (open, close, read, write, etc.).
+ In this sense, the file system is psuedo file system (in the
+ same sense that the Linux /proc file system is also
+ referred to as a psuedo file system).
+
+
- The NuttX filesystem is very simple; it does not involve any block drivers or
- particular filesystem (like FAT or EXT2 etc.).
- The NuttX filesystem simply supports a set a filesystem APIs
+ Any user supplied data or logic can be accessed via the psuedo-file system.
+ Built in support is provided for character and block drivers in the
+ /dev psuedo file system directory.
+
+
+Mounted File Systems
+ The simple in-memory file system can be extended my mounting block
+ devices that provide access to true file systems backed up via some
+ mass storage device.
+ NuttX supports the standard mount() command that allows
+ a block driver to be bound to a mountpoint within the psuedo file system
+ and to a a file system.
+ At present, NuttX supports only the VFAT file system.
+
+
+Comparison to Linux
+ From a programming perspective, the NuttX file system appears very similar
+ to a Linux file system.
+ However, there is a fundamental difference:
+ The NuttX root file system is a psuedo file system and true file systems may be
+ mounted in the psuedo file system.
+ In the typical Linux installation by comparison, the Linux root file system
+ is a true file system and psuedo file systems may be mounted in the true,
+ root file system.
+ The approach selected by NuttX is intended to support greater scalability
+ from the very tiny platform to the moderate platform.
+
+
+File System Interfaces.
+ The NuttX file system simply supports a set of standard, file system APIs
(open(), close(), read(), write, etc.)
and a registration mechanism that allows devices drivers to a associated with nodes
in a file-system-like name space.
@@ -6597,7 +6644,7 @@ notify a task when a message is available on a queue.
Directory operations
Driver operations
exit
- Filesystem interfaces
+ File system interfaces
getpid
getsockopt
gmtime_r