From 1e8e9ed9e6c88683016952de413797441c74df38 Mon Sep 17 00:00:00 2001 From: Theodore Ts'o Date: Wed, 27 Nov 2024 03:20:40 -0500 Subject: [PATCH] misc: sort the extended and journal options in man pages for tune2fs/mke2fs Signed-off-by: Theodore Ts'o --- misc/mke2fs.8.in | 218 +++++++++++++++++++++++++++--------------------------- misc/tune2fs.8.in | 152 ++++++++++++++++++------------------- 2 files changed, 185 insertions(+), 185 deletions(-) diff --git a/misc/mke2fs.8.in b/misc/mke2fs.8.in index c12b607..53ad58b 100644 --- a/misc/mke2fs.8.in +++ b/misc/mke2fs.8.in @@ -284,6 +284,21 @@ option is still accepted for backwards compatibility, but is deprecated. The following extended options are supported: .RS 1.2i .TP +.B assume_storage_prezeroed\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled, +.BR mke2fs +assumes that the storage device has been prezeroed, skips zeroing the journal +and inode tables, and annotates the block group flags to signal that the inode +table has been zeroed. +.TP +.B discard +Attempt to discard blocks at mkfs time (discarding blocks initially is useful +on solid state devices and sparse / thin-provisioned storage). When the device +advertises that discard also zeroes data (any subsequent read after the discard +and before write returns zero), then mark all not-yet-zeroed inode tables as +zeroed. This significantly speeds up file system initialization. This is set +as default. +.TP .BI encoding= encoding-name Enable the .I casefold @@ -309,46 +324,6 @@ In the default configuration, the .I strict flag is disabled. .TP -.BI mmp_update_interval= interval -Adjust the initial MMP update interval to -.I interval -seconds. Specifying an -.I interval -of 0 means to use the default interval. The specified interval must -be less than 300 seconds. Requires that the -.B mmp -feature be enabled. -.TP -.BI stride= stride-size -Configure the file system for a RAID array with -.I stride-size -file system blocks. This is the number of blocks read or written to disk -before moving to the next disk, which is sometimes referred to as the -.I chunk size. -This mostly affects placement of file system metadata like bitmaps at -.B mke2fs -time to avoid placing them on a single disk, which can hurt performance. -It may also be used by the block allocator. -.TP -.BI stripe_width= stripe-width -Configure the file system for a RAID array with -.I stripe-width -file system blocks per stripe. This is typically stride-size * N, where -N is the number of data-bearing disks in the RAID (e.g. for RAID 5 there is one -parity disk, so N will be the number of disks in the array minus 1). -This allows the block allocator to prevent read-modify-write of the -parity in a RAID stripe if possible when the data is written. -.TP -.BI offset= offset -Create the file system at an offset from the beginning of the device or -file. This can be useful when creating disk images for virtual machines. -.TP -.BI resize= max-online-resize -Reserve enough space so that the block group descriptor table can grow -to support a file system that has -.I max-online-resize -blocks. -.TP .B lazy_itable_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR] If enabled and the uninit_bg feature is enabled, the inode table will not be fully initialized by @@ -367,12 +342,17 @@ small risk if the system crashes before the journal has been overwritten entirely one time. If the option value is omitted, it defaults to 1 to enable lazy journal inode zeroing. .TP -.B assume_storage_prezeroed\fR[\fB= \fI<0 to disable, 1 to enable>\fR] -If enabled, -.BR mke2fs -assumes that the storage device has been prezeroed, skips zeroing the journal -and inode tables, and annotates the block group flags to signal that the inode -table has been zeroed. +.BI mmp_update_interval= interval +Adjust the initial MMP update interval to +.I interval +seconds. Specifying an +.I interval +of 0 means to use the default interval. The specified interval must +be less than 300 seconds. Requires that the +.B mmp +feature be enabled. +.B nodiscard +Do not attempt to discard blocks at mkfs time. .TP .B no_copy_xattrs Normally @@ -389,6 +369,16 @@ If the file system feature is enabled this option controls whether there will be 0, 1, or 2 backup superblocks created in the file system. .TP +.BI offset= offset +Create the file system at an offset from the beginning of the device or +file. This can be useful when creating disk images for virtual machines. +.TP +.TP +.BI orphan_file_size= size +Set size of the file for tracking unlinked but still open inodes and inodes +with truncate in progress. Larger file allows for better scalability, reserving +a few blocks per cpu is ideal. +.TP .B packed_meta_blocks\fR[\fB= \fI<0 to disable, 1 to enable>\fR] Place the allocation bitmaps and the inode table at the beginning of the disk. This option requires that the flex_bg file system feature to be @@ -399,6 +389,22 @@ It also maximizes the range of contiguous data blocks, which can be useful for certain specialized use cases, such as supported Shingled Drives. .TP +.B quotatype +Specify the which quota types (usrquota, grpquota, prjquota) which +should be enabled in the created file system. The argument of this +extended option should be a colon separated list. This option has +effect only if the +.B quota +feature is set. The default quota types to be initialized if this +option is not specified is both user and group quotas. If the project +feature is enabled that project quotas will be initialized as well. +.TP +.BI resize= max-online-resize +Reserve enough space so that the block group descriptor table can grow +to support a file system that has +.I max-online-resize +blocks. +.TP .BI root_owner [=uid:gid] Specify the numeric user and group ID of the root directory. If no UID:GID is specified, use the user and group ID of the user running \fBmke2fs\fR. @@ -413,35 +419,29 @@ Specify the root directory permissions in octal format. If no permissions are specified then the root directory permissions would be set in accordance with the default filesystem umask. .TP +.BI stride= stride-size +Configure the file system for a RAID array with +.I stride-size +file system blocks. This is the number of blocks read or written to disk +before moving to the next disk, which is sometimes referred to as the +.I chunk size. +This mostly affects placement of file system metadata like bitmaps at +.B mke2fs +time to avoid placing them on a single disk, which can hurt performance. +It may also be used by the block allocator. +.TP +.BI stripe_width= stripe-width +Configure the file system for a RAID array with +.I stripe-width +file system blocks per stripe. This is typically stride-size * N, where +N is the number of data-bearing disks in the RAID (e.g. for RAID 5 there is one +parity disk, so N will be the number of disks in the array minus 1). +This allows the block allocator to prevent read-modify-write of the +parity in a RAID stripe if possible when the data is written. +.TP .B test_fs Set a flag in the file system superblock indicating that it may be mounted using experimental kernel code, such as the ext4dev file system. -.TP -.BI orphan_file_size= size -Set size of the file for tracking unlinked but still open inodes and inodes -with truncate in progress. Larger file allows for better scalability, reserving -a few blocks per cpu is ideal. -.TP -.B discard -Attempt to discard blocks at mkfs time (discarding blocks initially is useful -on solid state devices and sparse / thin-provisioned storage). When the device -advertises that discard also zeroes data (any subsequent read after the discard -and before write returns zero), then mark all not-yet-zeroed inode tables as -zeroed. This significantly speeds up file system initialization. This is set -as default. -.TP -.B nodiscard -Do not attempt to discard blocks at mkfs time. -.TP -.B quotatype -Specify the which quota types (usrquota, grpquota, prjquota) which -should be enabled in the created file system. The argument of this -extended option should be a colon separated list. This option has -effect only if the -.B quota -feature is set. The default quota types to be initialized if this -option is not specified is both user and group quotas. If the project -feature is enabled that project quotas will be initialized as well. .RE .TP .B \-F @@ -532,43 +532,6 @@ Journal options are comma separated, and may take an argument using the equals ('=') sign. The following journal options are supported: .RS 1.2i -.TP -.BI size= journal-size -Create an internal journal (i.e., stored inside the file system) of size -.I journal-size -megabytes. -The size of the journal must be at least 1024 file system blocks -(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) -and may be no more than 10,240,000 file system blocks or half the total -file system size (whichever is smaller) -.TP -.BI fast_commit_size= fast-commit-size -Create an additional fast commit journal area of size -.I fast-commit-size -kilobytes. -This option is only valid if -.B fast_commit -feature is enabled -on the file system. If this option is not specified and if -.B fast_commit -feature is turned on, fast commit area size defaults to -.I journal-size -/ 64 megabytes. The total size of the journal with -.B fast_commit -feature set is -.I journal-size -+ ( -.I fast-commit-size -* 1024) megabytes. The total journal size may be no more than -10,240,000 file system blocks or half the total file system size -(whichever is smaller). -.TP -.BI location =journal-location -Specify the location of the journal. The argument -.I journal-location -can either be specified as a block number, or if the number has a units -suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the -beginning of the file system. @JDEV@.TP @JDEV@.BI device= external-journal @JDEV@Attach the file system to the journal block device located on @@ -602,6 +565,43 @@ beginning of the file system. @JDEV@.B -L @JDEV@option of @JDEV@.BR tune2fs (8). +.TP +.BI fast_commit_size= fast-commit-size +Create an additional fast commit journal area of size +.I fast-commit-size +kilobytes. +This option is only valid if +.B fast_commit +feature is enabled +on the file system. If this option is not specified and if +.B fast_commit +feature is turned on, fast commit area size defaults to +.I journal-size +/ 64 megabytes. The total size of the journal with +.B fast_commit +feature set is +.I journal-size ++ ( +.I fast-commit-size +* 1024) megabytes. The total journal size may be no more than +10,240,000 file system blocks or half the total file system size +(whichever is smaller). +.TP +.BI location =journal-location +Specify the location of the journal. The argument +.I journal-location +can either be specified as a block number, or if the number has a units +suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the +beginning of the file system. +.TP +.BI size= journal-size +Create an internal journal (i.e., stored inside the file system) of size +.I journal-size +megabytes. +The size of the journal must be at least 1024 file system blocks +(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) +and may be no more than 10,240,000 file system blocks or half the total +file system size (whichever is smaller) .RE @JDEV@.IP @JDEV@Only one of the diff --git a/misc/tune2fs.8.in b/misc/tune2fs.8.in index dcf108c..970f873 100644 --- a/misc/tune2fs.8.in +++ b/misc/tune2fs.8.in @@ -177,42 +177,6 @@ Reset the MMP block (if any) back to the clean state. Use only if absolutely certain the device is not currently mounted or being fscked, or major file system corruption can result. Needs '-f'. .TP -.BI mmp_update_interval= interval -Adjust the initial MMP update interval to -.I interval -seconds. Specifying an -.I interval -of 0 means to use the default interval. The specified interval must -be less than 300 seconds. Requires that the -.B mmp -feature be enabled. -.TP -.BI stride= stride-size -Configure the file system for a RAID array with -.I stride-size -file system blocks. This is the number of blocks read or written to disk -before moving to next disk. This mostly affects placement of file system -metadata like bitmaps at -.BR mke2fs (2) -time to avoid placing them on a single disk, which can hurt the performance. -It may also be used by block allocator. -.TP -.BI stripe_width= stripe-width -Configure the file system for a RAID array with -.I stripe-width -file system blocks per stripe. This is typically be stride-size * N, where -N is the number of data disks in the RAID (e.g. RAID 5 N+1, RAID 6 N+2). -This allows the block allocator to prevent read-modify-write of the -parity in a RAID stripe if possible when the data is written. -.TP -.BI hash_alg= hash-alg -Set the default hash algorithm used for file systems with hashed b-tree -directories. Valid algorithms accepted are: -.IR legacy , -.IR half_md4 , -and -.IR tea . -.TP .BI encoding= encoding-name Enable the .I casefold @@ -237,6 +201,28 @@ In the default configuration, the .I strict flag is disabled. .TP +.B force_fsck +Set a flag in the file system superblock indicating that errors have been found. +This will force fsck to run at the next mount. +.TP +.BI hash_alg= hash-alg +Set the default hash algorithm used for file systems with hashed b-tree +directories. Valid algorithms accepted are: +.IR legacy , +.IR half_md4 , +and +.IR tea . +.TP +.BI mmp_update_interval= interval +Adjust the initial MMP update interval to +.I interval +seconds. Specifying an +.I interval +of 0 means to use the default interval. The specified interval must +be less than 300 seconds. Requires that the +.B mmp +feature be enabled. +.TP .BI mount_opts= mount_option_string Set a set of default mount options which will be used when the file system is mounted. Unlike the bitmask-based default mount options which @@ -262,9 +248,23 @@ Set size of the file for tracking unlinked but still open inodes and inodes with truncate in progress. Larger file allows for better scalability, reserving a few blocks per cpu is ideal. .TP -.B force_fsck -Set a flag in the file system superblock indicating that errors have been found. -This will force fsck to run at the next mount. +.BI stride= stride-size +Configure the file system for a RAID array with +.I stride-size +file system blocks. This is the number of blocks read or written to disk +before moving to next disk. This mostly affects placement of file system +metadata like bitmaps at +.BR mke2fs (2) +time to avoid placing them on a single disk, which can hurt the performance. +It may also be used by block allocator. +.TP +.BI stripe_width= stripe-width +Configure the file system for a RAID array with +.I stripe-width +file system blocks per stripe. This is typically be stride-size * N, where +N is the number of data disks in the RAID (e.g. RAID 5 N+1, RAID 6 N+2). +This allows the block allocator to prevent read-modify-write of the +parity in a RAID stripe if possible when the data is written. .TP .B test_fs Set a flag in the file system superblock indicating that it may be @@ -371,43 +371,6 @@ Override the default ext3 journal parameters. Journal options are comma separated, and may take an argument using the equals ('=') sign. The following journal options are supported: .RS 1.2i -.TP -.BI size= journal-size -Create a journal stored in the file system of size -.I journal-size -megabytes. The size of the journal must be at least 1024 file system blocks -(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) -and may be no more than 10,240,000 file system blocks. -There must be enough free space in the file system to create a journal of -that size. -.TP -.BI fast_commit_size= fast-commit-size -Create an additional fast commit journal area of size -.I fast-commit-size -kilobytes. -This option is only valid if -.B fast_commit -feature is enabled -on the file system. If this option is not specified and if -.B fast_commit -feature is turned on, fast commit area size defaults to -.I journal-size -/ 64 megabytes. The total size of the journal with -.B fast_commit -feature set is -.I journal-size -+ ( -.I fast-commit-size -* 1024) megabytes. The total journal size may be no more than -10,240,000 file system blocks or half the total file system size -(whichever is smaller). -.TP -.BI location =journal-location -Specify the location of the journal. The argument -.I journal-location -can either be specified as a block number, or if the number has a units -suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the -beginning of the file system. @JDEV@.TP @JDEV@.BI device= external-journal @JDEV@Attach the file system to the journal block device located on @@ -441,6 +404,43 @@ beginning of the file system. @JDEV@.B -L @JDEV@option of @JDEV@.BR tune2fs (8). +.TP +.BI fast_commit_size= fast-commit-size +Create an additional fast commit journal area of size +.I fast-commit-size +kilobytes. +This option is only valid if +.B fast_commit +feature is enabled +on the file system. If this option is not specified and if +.B fast_commit +feature is turned on, fast commit area size defaults to +.I journal-size +/ 64 megabytes. The total size of the journal with +.B fast_commit +feature set is +.I journal-size ++ ( +.I fast-commit-size +* 1024) megabytes. The total journal size may be no more than +10,240,000 file system blocks or half the total file system size +(whichever is smaller). +.TP +.BI location =journal-location +Specify the location of the journal. The argument +.I journal-location +can either be specified as a block number, or if the number has a units +suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the +beginning of the file system. +.TP +.BI size= journal-size +Create a journal stored in the file system of size +.I journal-size +megabytes. The size of the journal must be at least 1024 file system blocks +(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) +and may be no more than 10,240,000 file system blocks. +There must be enough free space in the file system to create a journal of +that size. .RE @JDEV@.IP @JDEV@Only one of the -- 1.8.3.1