lk/linux-kernel-test
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

trivial: some small fixes in exofs documentation

Browse Source 
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>
This commit is contained in:
Thadeu Lima de Souza Cascardo
2009-07-27 13:26:32 -03:00
committed by Boaz Harrosh
parent 3067e02f8f
commit 9f249162fb
2 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/filesystems/00-INDEX
View File

@@ -36,6 +36,8 @@ dnotify.txt
- info about directory notification in Linux. - info about directory notification in Linux.
ecryptfs.txt ecryptfs.txt
- docs on eCryptfs: stacked cryptographic filesystem for Linux. - docs on eCryptfs: stacked cryptographic filesystem for Linux.
exofs.txt
- info, usage, mount options, design about EXOFS.
ext2.txt ext2.txt
- info, mount options and specifications for the Ext2 filesystem. - info, mount options and specifications for the Ext2 filesystem.
ext3.txt ext3.txt

23
Documentation/filesystems/exofs.txt
View File

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