Reorganized a lot per Jennifer's suggestions.

doc/filesystem/filesystem.texi

@@ -80,7 +80,7 @@ This is the online version of the RTEMS Filesystem Design Guide.
 * Pathname Evaluation::
 * System Initialization::
 * Mounting and Unmounting Filesystems::
-* Filesystem Requirements::
+* Filesystem Implementation Requirements::
 * In-Memory Filesystem::
 * System Call Development Notes::
 * Command and Variable Index::

doc/filesystem/fsrequirements.t

@@ -7,7 +7,7 @@
 @c
 
 
-@chapter Filesystem Requirements
+@chapter Filesystem Implementation Requirements
 
 This chapter details the behavioral requirements that all filesystem
 implementations must adhere to.
@@ -320,7 +320,7 @@ typedef struct @{
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection evalpath Handler
 
@@ -344,7 +344,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection evalformake Handler
 
@@ -368,7 +368,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection link Handler
 
@@ -403,7 +403,7 @@ the end of the name.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection unlink Handler
 
@@ -427,7 +427,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection node_type Handler
 
@@ -452,7 +452,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection mknod Handler
 
@@ -480,7 +480,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection rmnod Handler
 
@@ -504,7 +504,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection chown Handler
 
@@ -531,7 +531,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection freenod Handler
 
@@ -555,7 +555,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection mount Handler
 
@@ -580,7 +580,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection fsmount_me Handler
 
@@ -716,7 +716,7 @@ otherwise a 1 will be returned.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection unmount Handler
 
@@ -740,7 +740,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection fsunmount_me Handler
 
@@ -766,7 +766,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection utime Handler
 
@@ -789,7 +789,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection eval_link Handler
 
@@ -812,7 +812,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection symlink Handler
 
@@ -835,7 +835,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 @subsection File Handler Table Functions
 
 Handler table functions are defined in a @code{rtems_filesystem_file_handlers_r}
@@ -866,7 +866,7 @@ typedef struct @{
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection open Handler
 
@@ -894,7 +894,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection close Handler
 
@@ -925,7 +925,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection read Handler
 
@@ -957,7 +957,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection write Handler
 
@@ -984,7 +984,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection ioctl Handler
 
@@ -1016,7 +1016,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection lseek Handler
 
@@ -1048,7 +1048,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection fstat Handler
 
@@ -1100,7 +1100,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection fchmod Handler
 
@@ -1131,7 +1131,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection ftruncate Handler
 
@@ -1179,7 +1179,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection fsync Handler
 
@@ -1205,7 +1205,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection fdatasync Handler
 
@@ -1232,7 +1232,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection fcntl Handler
 

doc/filesystem/imfs.t

@@ -205,7 +205,7 @@ rtems_filesystem_operations_table  IMFS_ops = @{
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_evalpath()
 
@@ -229,7 +229,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_evalformake()
 
@@ -253,7 +253,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_link()
 
@@ -313,7 +313,7 @@ hard-link.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_unlink()
 
@@ -337,7 +337,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_node_type()
 
@@ -379,7 +379,7 @@ The IMFS_jnode_t type element indicates one of the node types listed below:
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_mknod()
 
@@ -417,7 +417,7 @@ attempt to allocate space for the @code{jnode} (ENOMEN).
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_rmnod()
 
@@ -441,7 +441,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_chown()
 
@@ -477,7 +477,7 @@ ownership of the IMFS_jnode_t structure.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_freenod()
 
@@ -501,7 +501,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_mount()
 
@@ -539,7 +539,7 @@ describes the filesystem mounted at this point.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_fsmount_me()
 
@@ -675,7 +675,7 @@ otherwise a 1 will be returned.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_unmount()
 
@@ -699,7 +699,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_fsunmount_me()
 
@@ -725,7 +725,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_utime()
 
@@ -749,7 +749,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_eval_link()
 
@@ -772,7 +772,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 @subsection Regular File Handler Table Functions
 
 Handler table functions are defined in a rtems_filesystem_file_handlers_r
@@ -804,7 +804,7 @@ rtems_filesystem_file_handlers_r IMFS_memfile_handlers = @{
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection memfile_open() for Regular Files
 
@@ -833,7 +833,7 @@ a success code is always returned.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection memfile_close() for Regular Files
 
@@ -861,7 +861,7 @@ and then immediately returns a success status.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection memfile_read() for Regular Files
 
@@ -907,7 +907,7 @@ IMFS_memfile_read() will do the following:
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection memfile_write() for Regular Files
 
@@ -929,7 +929,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection memfile_ioctl() for Regular Files
 
@@ -957,7 +957,7 @@ a successful completion status.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection memfile_lseek() for Regular Files
 
@@ -989,7 +989,7 @@ file position index. A success code is always returned from this routine.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_stat() for Regular Files
 
@@ -1050,7 +1050,7 @@ structure:
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_fchmod() for Regular Files
 
@@ -1090,7 +1090,7 @@ based on the mode calling parameter.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection memfile_ftruncate() for Regular Files
 
@@ -1132,7 +1132,7 @@ Not Implemented
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No fsync() for Regular Files
 
@@ -1155,7 +1155,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_fdatasync() for Regular Files
 
@@ -1177,7 +1177,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 @subsection Directory Handler Table Functions
 
 Handler table functions are defined in a rtems_filesystem_file_handlers_r
@@ -1209,7 +1209,7 @@ rtems_filesystem_file_handlers_r IMFS_directory_handlers = @{
 @c
 @c
 @c
-@page
+@c @page
 @subsubsection IMFS_dir_open() for Directories
 
 @subheading Corresponding Structure Element:
@@ -1243,7 +1243,7 @@ This allows us to start reading at the beginning of the directory.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_dir_close() for Directories
 
@@ -1269,7 +1269,7 @@ immediately returns a success status.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_dir_read() for Directories
 
@@ -1299,7 +1299,7 @@ this routine.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No write() for Directories
 
@@ -1322,7 +1322,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No ioctl() for Directories
 
@@ -1344,7 +1344,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_dir_lseek() for Directories
 
@@ -1377,7 +1377,7 @@ the open directory.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_dir_fstat() for Directories
 
@@ -1422,7 +1422,7 @@ of the children of the directory.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_fchmod() for Directories
 
@@ -1462,7 +1462,7 @@ based on the mode calling parameter.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No ftruncate() for Directories
 
@@ -1485,7 +1485,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No fpathconf() for Directories
 
@@ -1509,7 +1509,7 @@ Not Implemented
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No fsync() for Directories
 
@@ -1532,7 +1532,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_fdatasync() for Directories
 
@@ -1555,7 +1555,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 @subsection Device Handler Table Functions
 
 Handler table functions are defined in a rtems_filesystem_file_handlers_r
@@ -1585,7 +1585,7 @@ typedef struct @{
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection device_open() for Devices
 
@@ -1620,7 +1620,7 @@ driver that contains the file control block, flags and mode information.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection device_close() for Devices
 
@@ -1652,7 +1652,7 @@ major and minor device numbers.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection device_read() for Devices
 
@@ -1702,7 +1702,7 @@ read will be returned to the calling program.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection device_write() for Devices
 
@@ -1724,7 +1724,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection device_ioctl() for Devices
 
@@ -1769,7 +1769,7 @@ the calling program, otherwise the ioctl_return value is returned.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection device_lseek() for Devices
 
@@ -1797,7 +1797,7 @@ successful status.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_stat() for Devices
 
@@ -1858,7 +1858,7 @@ structure:
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection IMFS_fchmod() for Devices
 
@@ -1899,7 +1899,7 @@ based on the mode calling parameter.
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No ftruncate() for Devices
 
@@ -1921,7 +1921,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No fpathconf() for Devices
 
@@ -1945,7 +1945,7 @@ Not Implemented
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No fsync() for Devices
 
@@ -1969,7 +1969,7 @@ XXX
 @c
 @c
 @c
-@page
+@c @page
 
 @subsubsection No fdatasync() for Devices
 

doc/filesystem/syscalls.t

@@ -45,7 +45,7 @@ been included as part of the application's interface.
 The sections that follow provide developmental information concerning each of these functions.
 
  
-@page
+@c @page
 @section access
 
 @subheading File:
@@ -65,7 +65,7 @@ This routine is layered on top of the stat() function. As long as the st_mode
 element in the returned structure follow the standard UNIX conventions, this 
 function should support other filesystems without alteration.
 
-@page
+@c @page
 @section chdir
 
 @subheading File:
@@ -107,7 +107,7 @@ determine if the structure is valid, you must first test the node_access element
 this structure. If the pointer is NULL, then the structure does not contain a valid 
 indication of what the current directory is.
 
-@page
+@c @page
 @section chmod
 
 @subheading File:
@@ -116,7 +116,7 @@ chmod.c
 
 @subheading Processing: 
 
-This routine is layered on the open(), fchmod () and close () functions. As long as 
+This routine is layered on the open(), fchmod() and close() functions. As long as 
 the standard interpretation of the mode_t value is maintained, this routine should 
 not need modification to support other filesystems.
 
@@ -131,7 +131,7 @@ integer file descriptor returned by the open() function.
 
 After mode modification, the open file descriptor is closed.
 
-@page
+@c @page
 @section chown
 
 @subheading File:
@@ -159,7 +159,7 @@ If the chown() function is defined in the indicated OPS table, the function is
 called with the rtems_filesystem_location_info_t structure returned from the path 
 evaluation routine, the desired owner, and group information.
 
-@page
+@c @page
 @section close
 
 @subheading File:
@@ -217,7 +217,7 @@ program.
 
 @end enumerate
 
-@page
+@c @page
 @section closedir
 
 @subheading File:
@@ -228,7 +228,7 @@ closedir.c
 
 The code was obtained from the BSD group. This routine must clean up the 
 memory resources that are required to track an open directory. The code is layered 
-on the close() function and standard memory free () functions. It should not 
+on the close() function and standard memory free() functions. It should not 
 require alterations to support other filesystems.
 
 @subheading Development Comments:
@@ -245,7 +245,7 @@ DIR control memory is reallocated.
 The close() function is used to free the file descriptor index.
 
 
-@page
+@c @page
 @section dup()      Unimplemented
 
 @subheading File:
@@ -261,7 +261,7 @@ dup.c
 
 
 
-@page
+@c @page
 @section dup2()      Unimplemented
 
 @subheading File:
@@ -278,7 +278,7 @@ dup2.c
 
 
 
-@page
+@c @page
 @section fchmod
 
 @subheading File:
@@ -322,7 +322,7 @@ an error is returned to the calling routine.
 If the fchmod() handler function exists, it is called with the file control block and 
 the desired mode as parameters.
 
-@page
+@c @page
 @section fcntl()
 
 @subheading File:
@@ -340,7 +340,7 @@ implementations.
 
 The only commands that have been implemented are the F_GETFD and 
 F_SETFD. The commands manipulate the LIBIO_FLAGS_CLOSE_ON_EXEC 
-bit in the -flags- element of the file control block associated with the file 
+bit in the @code{flags} element of the file control block associated with the file 
 descriptor index.
 
 The current implementation of the function performs the sequence of operations 
@@ -359,7 +359,7 @@ network connection
 
 
 
-@page
+@c @page
 @section fdatasync
 
 @subheading File:
@@ -407,7 +407,7 @@ an error is returned to the calling routine.
 If the fdatasync() handler function exists, it is called with the file control block as 
 its parameter.
 
-@page
+@c @page
 @section fpathconf
 
 @subheading File:
@@ -490,7 +490,7 @@ The name argument is used to reference the desired constant from the
 pathconf_limits_and_options table.
 
 
-@page
+@c @page
 @section fstat
 
 @subheading File:
@@ -537,7 +537,7 @@ control block and the pointer to the stat structure.
 
 @end enumerate
 
-@page
+@c @page
 @section ioctl
 
 @subheading File:
@@ -580,7 +580,7 @@ the command and buffer as its parameters.
 @end enumerate
 
 
-@page
+@c @page
 @section link
 
 @subheading File:
@@ -621,13 +621,13 @@ to create will cross a filesystem boundary. This is not permitted for hard-links
 If the hard-link does not cross a filesystem boundary, a check is performed to 
 determine if the OPS table contains an entry for the link() function.
 
-If a link() function is defined, the OPS table link () function will be called to 
+If a link() function is defined, the OPS table link() function will be called to 
 establish the actual link within the filesystem.
 
 The return code from the OPS table link() function is returned to the calling 
 program.
 
-@page
+@c @page
 @section lseek
 
 @subheading File:
@@ -672,7 +672,7 @@ calling program
 @end enumerate
 
 
-@page
+@c @page
 @section mkdir
 
 @subheading File:
@@ -688,7 +688,7 @@ is layered the mknod() function.
 
 See mknod() for developmental comments.
 
-@page
+@c @page
 @section mkfifo
 
 @subheading File:
@@ -704,7 +704,7 @@ layered the mknod() function.
 
 See mknod() for developmental comments
 
-@page
+@c @page
 @section mknod
 
 @subheading File:
@@ -770,11 +770,11 @@ creation of a node.
 If the pathname is a valid location to create a node, verify that a filesystem 
 specific mknod() function exists.
 
-If the mknod() function exists, call the filesystem specific mknod () function. 
+If the mknod() function exists, call the filesystem specific mknod() function. 
 Pass the name, mode, device type and the location information associated with the 
 directory under which the node will be created. 
 
-@page
+@c @page
 @section mount
 
 @subheading File:
@@ -822,7 +822,7 @@ This routine will handle the mounting of a filesystem on a mount point. If the
 operation is successful, a pointer to the mount table chain entry associated with 
 the mounted filesystem will be returned to the calling function. The specifics 
 about the processing required at the mount point and within the filesystem being 
-mounted is isolated in the filesystem specific mount() and fsmount_me () 
+mounted is isolated in the filesystem specific mount() and fsmount_me() 
 functions. This allows the generic mount() function to remain unaltered even if 
 new filesystem types are introduced.
 
@@ -859,7 +859,7 @@ mounted, that function is called to initialize for the new filesystem.
 On successful completion, the temporary mount table entry will be placed on the 
 mount table chain to record the presence of the mounted filesystem.
 
-@page
+@c @page
 @section open
 
 @subheading File:
@@ -905,7 +905,7 @@ open() routine.
 On a successful open(), the index into the file descriptor table will be calculated 
 and returned to the calling routine.
 
-@page
+@c @page
 @section opendir
 
 @subheading File:
@@ -923,7 +923,7 @@ processing routines.
 
 The BSD group provided this routine.
 
-@page
+@c @page
 @section pathconf
 
 @subheading File:
@@ -933,7 +933,7 @@ pathconf.c
 @subheading Processing: 
 
 This routine will obtain the value of one of the path configuration parameters and 
-return it to the calling routine. It is layered on the generic open() and fpathconf () 
+return it to the calling routine. It is layered on the generic open() and fpathconf() 
 functions. These interfaces should not change with the addition of new filesystem 
 types.
 
@@ -942,11 +942,11 @@ types.
 This routine will try to open the file indicated by path. 
 
 If successful, the file descriptor will be used to access the pathconf value specified 
-by -name- using the fpathconf() function.
+by @code{name} using the fpathconf() function.
 
 The file that was accessed is then closed.
 
-@page
+@c @page
 @section read
 
 @subheading File:
@@ -992,7 +992,7 @@ bytes read) to increment the offset element of the file control block
 
 @end enumerate
 
-@page
+@c @page
 @section readdir
 
 @subheading File:
@@ -1012,7 +1012,7 @@ This routine provides the filesystem specific aspects of reading a directory.
 It is layered on the read() function in the directory handler table. This function 
 has been mapped to the Imfs_dir_read() function.
 
-@page
+@c @page
 @section unmount
 
 @subheading File:
@@ -1061,7 +1061,7 @@ from the mount table chain.
 
 @end enumerate
 
-@page
+@c @page
 @section eval
 
 @subheading File:
@@ -1076,7 +1076,7 @@ XXX
 
 XXX
 
-@page
+@c @page
 @section getdentsc
 
 @subheading File: