Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[PATCH] Docs update: small spelling, formating etc fixes for filesystems/ext3.txt

Spelling fixes, formating changes and corrections for
Documentation/filesystems/ext3.txt

Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

authored by

Jesper Juhl and committed by
Linus Torvalds
c63ca3c8 c594a50d

+90 -88
+90 -88
Documentation/filesystems/ext3.txt
··· 2 2 Ext3 Filesystem 3 3 =============== 4 4 5 - ext3 was originally released in September 1999. Written by Stephen Tweedie 6 - for 2.2 branch, and ported to 2.4 kernels by Peter Braam, Andreas Dilger, 5 + Ext3 was originally released in September 1999. Written by Stephen Tweedie 6 + for the 2.2 branch, and ported to 2.4 kernels by Peter Braam, Andreas Dilger, 7 7 Andrew Morton, Alexander Viro, Ted Ts'o and Stephen Tweedie. 8 8 9 - ext3 is ext2 filesystem enhanced with journalling capabilities. 9 + Ext3 is the ext2 filesystem enhanced with journalling capabilities. 10 10 11 11 Options 12 12 ======= ··· 14 14 When mounting an ext3 filesystem, the following option are accepted: 15 15 (*) == default 16 16 17 - jounal=update Update the ext3 file system's journal to the 18 - current format. 17 + journal=update Update the ext3 file system's journal to the current 18 + format. 19 19 20 - journal=inum When a journal already exists, this option is 21 - ignored. Otherwise, it specifies the number of 22 - the inode which will represent the ext3 file 23 - system's journal file. 20 + journal=inum When a journal already exists, this option is ignored. 21 + Otherwise, it specifies the number of the inode which 22 + will represent the ext3 file system's journal file. 24 23 25 24 journal_dev=devnum When the external journal device's major/minor numbers 26 - have changed, this option allows to specify the new 27 - journal location. The journal device is identified 28 - through its new major/minor numbers encoded in devnum. 25 + have changed, this option allows the user to specify 26 + the new journal location. The journal device is 27 + identified through its new major/minor numbers encoded 28 + in devnum. 29 29 30 30 noload Don't load the journal on mounting. 31 31 32 - data=journal All data are committed into the journal prior 33 - to being written into the main file system. 32 + data=journal All data are committed into the journal prior to being 33 + written into the main file system. 34 34 35 35 data=ordered (*) All data are forced directly out to the main file 36 - system prior to its metadata being committed to 37 - the journal. 36 + system prior to its metadata being committed to the 37 + journal. 38 38 39 - data=writeback Data ordering is not preserved, data may be 40 - written into the main file system after its 41 - metadata has been committed to the journal. 39 + data=writeback Data ordering is not preserved, data may be written 40 + into the main file system after its metadata has been 41 + committed to the journal. 42 42 43 43 commit=nrsec (*) Ext3 can be told to sync all its data and metadata 44 44 every 'nrsec' seconds. The default value is 5 seconds. 45 - This means that if you lose your power, you will lose, 46 - as much, the latest 5 seconds of work (your filesystem 47 - will not be damaged though, thanks to journaling). This 48 - default value (or any low value) will hurt performance, 49 - but it's good for data-safety. Setting it to 0 will 50 - have the same effect than leaving the default 5 sec. 45 + This means that if you lose your power, you will lose 46 + as much as the latest 5 seconds of work (your 47 + filesystem will not be damaged though, thanks to the 48 + journaling). This default value (or any low value) 49 + will hurt performance, but it's good for data-safety. 50 + Setting it to 0 will have the same effect as leaving 51 + it at the default (5 seconds). 51 52 Setting it to very large values will improve 52 53 performance. 53 54 54 - barrier=1 This enables/disables barriers. barrier=0 disables it, 55 - barrier=1 enables it. 55 + barrier=1 This enables/disables barriers. barrier=0 disables 56 + it, barrier=1 enables it. 56 57 57 - orlov (*) This enables the new Orlov block allocator. It's enabled 58 - by default. 58 + orlov (*) This enables the new Orlov block allocator. It is 59 + enabled by default. 59 60 60 - oldalloc This disables the Orlov block allocator and enables the 61 - old block allocator. Orlov should have better performance, 62 - we'd like to get some feedback if it's the contrary for 63 - you. 61 + oldalloc This disables the Orlov block allocator and enables 62 + the old block allocator. Orlov should have better 63 + performance - we'd like to get some feedback if it's 64 + the contrary for you. 64 65 65 - user_xattr Enables Extended User Attributes. Additionally, you need 66 - to have extended attribute support enabled in the kernel 67 - configuration (CONFIG_EXT3_FS_XATTR). See the attr(5) 68 - manual page and http://acl.bestbits.at to learn more 69 - about extended attributes. 66 + user_xattr Enables Extended User Attributes. Additionally, you 67 + need to have extended attribute support enabled in the 68 + kernel configuration (CONFIG_EXT3_FS_XATTR). See the 69 + attr(5) manual page and http://acl.bestbits.at/ to 70 + learn more about extended attributes. 70 71 71 72 nouser_xattr Disables Extended User Attributes. 72 73 73 - acl Enables POSIX Access Control Lists support. Additionally, 74 - you need to have ACL support enabled in the kernel 75 - configuration (CONFIG_EXT3_FS_POSIX_ACL). See the acl(5) 76 - manual page and http://acl.bestbits.at for more 77 - information. 74 + acl Enables POSIX Access Control Lists support. 75 + Additionally, you need to have ACL support enabled in 76 + the kernel configuration (CONFIG_EXT3_FS_POSIX_ACL). 77 + See the acl(5) manual page and http://acl.bestbits.at/ 78 + for more information. 78 79 79 - noacl This option disables POSIX Access Control List support. 80 + noacl This option disables POSIX Access Control List 81 + support. 80 82 81 83 reservation 82 84 ··· 90 88 minixdf Make 'df' act like Minix. 91 89 92 90 check=none Don't do extra checking of bitmaps on mount. 93 - nocheck 91 + nocheck 94 92 95 93 debug Extra debugging information is sent to syslog. 96 94 ··· 99 97 errors=panic Panic and halt the machine if an error occurs. 100 98 101 99 grpid Give objects the same group ID as their creator. 102 - bsdgroups 100 + bsdgroups 103 101 104 102 nogrpid (*) New objects have the group ID of their creator. 105 103 sysvgroups ··· 110 108 111 109 sb=n Use alternate superblock at this location. 112 110 113 - quota Quota options are currently silently ignored. 114 - noquota (see fs/ext3/super.c, line 594) 111 + quota 112 + noquota 115 113 grpquota 116 114 usrquota 117 115 118 116 119 117 Specification 120 118 ============= 121 - ext3 shares all disk implementation with ext2 filesystem, and add 122 - transactions capabilities to ext2. Journaling is done by the 123 - Journaling block device layer. 119 + Ext3 shares all disk implementation with the ext2 filesystem, and adds 120 + transactions capabilities to ext2. Journaling is done by the Journaling Block 121 + Device layer. 124 122 125 123 Journaling Block Device layer 126 124 ----------------------------- 127 - The Journaling Block Device layer (JBD) isn't ext3 specific. It was 128 - design to add journaling capabilities on a block device. The ext3 129 - filesystem code will inform the JBD of modifications it is performing 130 - (Call a transaction). the journal support the transactions start and 131 - stop, and in case of crash, the journal can replayed the transactions 132 - to put the partition on a consistent state fastly. 125 + The Journaling Block Device layer (JBD) isn't ext3 specific. It was design to 126 + add journaling capabilities on a block device. The ext3 filesystem code will 127 + inform the JBD of modifications it is performing (called a transaction). The 128 + journal supports the transactions start and stop, and in case of crash, the 129 + journal can replayed the transactions to put the partition back in a 130 + consistent state fast. 133 131 134 - handles represent a single atomic update to a filesystem. JBD can 135 - handle external journal on a block device. 132 + Handles represent a single atomic update to a filesystem. JBD can handle an 133 + external journal on a block device. 136 134 137 135 Data Mode 138 136 --------- 139 - There's 3 different data modes: 137 + There are 3 different data modes: 140 138 141 139 * writeback mode 142 - In data=writeback mode, ext3 does not journal data at all. This mode 143 - provides a similar level of journaling as XFS, JFS, and ReiserFS in its 144 - default mode - metadata journaling. A crash+recovery can cause 145 - incorrect data to appear in files which were written shortly before the 146 - crash. This mode will typically provide the best ext3 performance. 140 + In data=writeback mode, ext3 does not journal data at all. This mode provides 141 + a similar level of journaling as that of XFS, JFS, and ReiserFS in its default 142 + mode - metadata journaling. A crash+recovery can cause incorrect data to 143 + appear in files which were written shortly before the crash. This mode will 144 + typically provide the best ext3 performance. 147 145 148 146 * ordered mode 149 - In data=ordered mode, ext3 only officially journals metadata, but it 150 - logically groups metadata and data blocks into a single unit called a 151 - transaction. When it's time to write the new metadata out to disk, the 152 - associated data blocks are written first. In general, this mode 153 - perform slightly slower than writeback but significantly faster than 154 - journal mode. 147 + In data=ordered mode, ext3 only officially journals metadata, but it logically 148 + groups metadata and data blocks into a single unit called a transaction. When 149 + it's time to write the new metadata out to disk, the associated data blocks 150 + are written first. In general, this mode performs slightly slower than 151 + writeback but significantly faster than journal mode. 155 152 156 153 * journal mode 157 - data=journal mode provides full data and metadata journaling. All new 158 - data is written to the journal first, and then to its final location. 159 - In the event of a crash, the journal can be replayed, bringing both 160 - data and metadata into a consistent state. This mode is the slowest 161 - except when data needs to be read from and written to disk at the same 162 - time where it outperform all others mode. 154 + data=journal mode provides full data and metadata journaling. All new data is 155 + written to the journal first, and then to its final location. 156 + In the event of a crash, the journal can be replayed, bringing both data and 157 + metadata into a consistent state. This mode is the slowest except when data 158 + needs to be read from and written to disk at the same time where it 159 + outperforms all others modes. 163 160 164 161 Compatibility 165 162 ------------- 166 163 167 164 Ext2 partitions can be easily convert to ext3, with `tune2fs -j <dev>`. 168 - Ext3 is fully compatible with Ext2. Ext3 partitions can easily be 169 - mounted as Ext2. 165 + Ext3 is fully compatible with Ext2. Ext3 partitions can easily be mounted as 166 + Ext2. 167 + 170 168 171 169 External Tools 172 170 ============== 173 - see manual pages to know more. 171 + See manual pages to learn more. 174 172 175 - tune2fs: create a ext3 journal on a ext2 partition with the -j flags 176 - mke2fs: create a ext3 partition with the -j flags 177 - debugfs: ext2 and ext3 file system debugger 173 + tune2fs: create a ext3 journal on a ext2 partition with the -j flag. 174 + mke2fs: create a ext3 partition with the -j flag. 175 + debugfs: ext2 and ext3 file system debugger. 176 + 178 177 179 178 References 180 179 ========== 181 180 182 - kernel source: file:/usr/src/linux/fs/ext3 183 - file:/usr/src/linux/fs/jbd 181 + kernel source: <file:fs/ext3/> 182 + <file:fs/jbd/> 184 183 185 - programs: http://e2fsprogs.sourceforge.net 184 + programs: http://e2fsprogs.sourceforge.net/ 186 185 187 - useful link: 188 - http://www.zip.com.au/~akpm/linux/ext3/ext3-usage.html 186 + useful links: http://www.zip.com.au/~akpm/linux/ext3/ext3-usage.html 189 187 http://www-106.ibm.com/developerworks/linux/library/l-fs7/ 190 188 http://www-106.ibm.com/developerworks/linux/library/l-fs8/