]> git.openfabrics.org - ~shefty/rdma-dev.git/commitdiff
trivial: some small fixes in exofs documentation
authorThadeu Lima de Souza Cascardo <cascardo@holoscopio.com>
Mon, 27 Jul 2009 16:26:32 +0000 (13:26 -0300)
committerBoaz Harrosh <bharrosh@panasas.com>
Thu, 10 Dec 2009 07:59:16 +0000 (09:59 +0200)
Add exofs.txt to filesystems Documentation index and fix some typos,
identation and grammar.

Signed-off-by: Thadeu Lima de Souza Cascardo <cascardo@holoscopio.com>
Signed-off-by: Boaz Harrosh <bharrosh@panasas.com>
Documentation/filesystems/00-INDEX
Documentation/filesystems/exofs.txt

index f15621ee55996e0a0928f08783ddcaa43ddfee21..7001782ab932dbc3a8b5a16b8188c8a2605d84d3 100644 (file)
@@ -36,6 +36,8 @@ dnotify.txt
        - info about directory notification in Linux.
 ecryptfs.txt
        - docs on eCryptfs: stacked cryptographic filesystem for Linux.
+exofs.txt
+       - info, usage, mount options, design about EXOFS.
 ext2.txt
        - info, mount options and specifications for the Ext2 filesystem.
 ext3.txt
index 0ced74c2f73c57a489413a0aa226da45a778016d..abd2a9b5b787c324034f24d3a84523f99c657de1 100644 (file)
@@ -60,13 +60,13 @@ USAGE
 
    mkfs.exofs --pid=65536 --format /dev/osd0
 
-   The --format is optional if not specified no OSD_FORMAT will be
-   preformed and a clean file system will be created in the specified pid,
+   The --format is optional. If not specified, no OSD_FORMAT will be
+   performed and a clean file system will be created in the specified pid,
    in the available space of the target. (Use --format=size_in_meg to limit
    the total LUN space available)
 
-   If pid already exist it will be deleted and a new one will be created in it's
-   place. Be careful.
+   If pid already exists, it will be deleted and a new one will be created in
+   its place. Be careful.
 
    An exofs lives inside a single OSD partition. You can create multiple exofs
    filesystems on the same device using multiple pids.
@@ -81,7 +81,7 @@ USAGE
 
 7. For reference (See do-exofs example script):
        do-exofs start - an example of how to perform the above steps.
-       do-exofs stop -  an example of how to unmount the file system.
+       do-exofs stop - an example of how to unmount the file system.
        do-exofs format - an example of how to format and mkfs a new exofs.
 
 8. Extra compilation flags (uncomment in fs/exofs/Kbuild):
@@ -104,8 +104,8 @@ Where:
     exofs specific options: Options are separated by commas (,)
                pid=<integer> - The partition number to mount/create as
                                 container of the filesystem.
-                                This option is mandatory
-                to=<integer>  - Timeout in ticks for a single command
+                                This option is mandatory.
+                to=<integer>  - Timeout in ticks for a single command.
                                 default is (60 * HZ) [for debugging only]
 
 ===============================================================================
@@ -116,7 +116,7 @@ DESIGN
   with a special ID (defined in common.h).
   Information included in the file system control block is used to fill the
   in-memory superblock structure at mount time. This object is created before
-  the file system is used by mkexofs.c It contains information such as:
+  the file system is used by mkexofs.c. It contains information such as:
        - The file system's magic number
        - The next inode number to be allocated
 
@@ -134,8 +134,8 @@ DESIGN
   attributes. This applies to both regular files and other types (directories,
   device files, symlinks, etc.).
 
-* Credentials are generated per object (inode and superblock) when they is
-  created in memory (read off disk or created). The credential works for all
+* Credentials are generated per object (inode and superblock) when they are
+  created in memory (read from disk or created). The credential works for all
   operations and is used as long as the object remains in memory.
 
 * Async OSD operations are used whenever possible, but the target may execute
@@ -145,7 +145,8 @@ DESIGN
   from executing in reverse order:
        - The following are handled with the OBJ_CREATED and OBJ_2BCREATED
          flags. OBJ_CREATED is set when we know the object exists on the OSD -
-         in create's callback function, and when we successfully do a read_inode.
+         in create's callback function, and when we successfully do a
+         read_inode.
          OBJ_2BCREATED is set in the beginning of the create function, so we
          know that we should wait.
                - create/delete: delete should wait until the object is created