btrfs-progs: mkfs: update help text

Enhance information in the help text where some interesting information
was not missing and would require looking up the documentation.

Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2025-01-23 02:17:21 +01:00
parent 0552d219b6
commit b5e7734220

View File

@ -431,16 +431,16 @@ static const char * const mkfs_usage[] = {
"Features:",
OPTLINE("--csum TYPE", ""),
OPTLINE("--checksum TYPE", "checksum algorithm to use, crc32c (default), xxhash, sha256, blake2"),
OPTLINE("-n|--nodesize SIZE", "size of btree nodes"),
OPTLINE("-s|--sectorsize SIZE", "data block size (may not be mountable by current kernel)"),
OPTLINE("-n|--nodesize SIZE", "size of btree nodes (default 16K)"),
OPTLINE("-s|--sectorsize SIZE", "data block size (default 4K, may not be mountable by current kernel if CPU page size is different)"),
OPTLINE("-O|--features LIST", "comma separated list of filesystem features (use '-O list-all' to list features)"),
OPTLINE("-L|--label LABEL", "set the filesystem label"),
OPTLINE("-L|--label LABEL", "set the filesystem label (maximum length 255)"),
OPTLINE("-U|--uuid UUID", "specify the filesystem UUID (must be unique for a filesystem with multiple devices)"),
OPTLINE("--device-uuid UUID", "Specify the filesystem device UUID (a.k.a sub-uuid) (for single device filesystem only)"),
OPTLINE("--device-uuid UUID", "specify the filesystem device UUID (a.k.a sub-uuid) (for single device filesystem only)"),
"",
"Creation:",
OPTLINE("-b|--byte-count SIZE", "set size of each device to SIZE (filesystem size is sum of all device sizes)"),
OPTLINE("-r|--rootdir DIR", "copy files from DIR to the image root directory"),
OPTLINE("-r|--rootdir DIR", "copy files from DIR to the image root directory, can be combined with --subvol"),
OPTLINE("--compress ALGO[:LEVEL]", "compress files by algorithm and level, ALGO can be 'no' (default), zstd, lzo, zlib"),
OPTLINE("", "Built-in:"),
#if COMPRESSION_ZSTD
@ -455,6 +455,11 @@ static const char * const mkfs_usage[] = {
#endif
OPTLINE("", "- ZLIB: yes (levels 1..9)"),
OPTLINE("-u|--subvol TYPE:SUBDIR", "create SUBDIR as subvolume rather than normal directory, can be specified multiple times"),
OPTLINE("", "TYPE is one of:"),
OPTLINE("", "- rw - (default) create a writeable subvolume in SUBDIR"),
OPTLINE("", "- ro - create the subvolume as read-only"),
OPTLINE("", "- default - the SUBDIR will be a subvolume and also set as default (can be specified only once)"),
OPTLINE("", "- defalut-ro - like 'default' and is created as read-only subvolume (can be specified only once)"),
OPTLINE("--shrink", "(with --rootdir) shrink the filled filesystem to minimal size"),
OPTLINE("-K|--nodiscard", "do not perform whole device TRIM"),
OPTLINE("-f|--force", "force overwrite of existing filesystem"),