btrfs-progs: unify parameter references

Drop the < > around the value spec, update to the meaning. This is still
nto complete as some options could take values that can be further
interpreted like size with offsets.

Signed-off-by: David Sterba <dsterba@suse.com>

Author: kdave

check/main.c

@@ -10571,10 +10571,10 @@ static const char * const cmd_check_usage[] = {
 	"         without prior analysis of problems found on the filesystem.",
 	"",
 	"Starting point selection:",
-	OPTLINE("-s, --super <superblock>", "use this superblock copy"),
+	OPTLINE("-s, --super NUMBER", "use this superblock copy"),
 	OPTLINE("-b, --backup", "use the first valid backup root copy"),
-	OPTLINE("-r, --tree-root <bytenr>", "use the given bytenr for the tree root"),
-	OPTLINE("--chunk-root <bytenr>", "use the given bytenr for the chunk tree root"),
+	OPTLINE("-r, --tree-root ", "use the given bytenr for the tree root"),
+	OPTLINE("--chunk-root BYTENR", "use the given bytenr for the chunk tree root"),
 	"",
 	"Operation modes:",
 	OPTLINE("--readonly", "run in read-only mode (default)"),
@@ -10583,7 +10583,7 @@ static const char * const cmd_check_usage[] = {
 			"WARNING: it is possible to run with --repair but on a mounted filesystem "
 			"that will most likely lead to a corruption unless the filesystem "
 			"is quiescent in a quiescent state which may not be possible to guarantee"),
-	OPTLINE("--mode <MODE>", "allows choice of memory/IO trade-offs where MODE is one of:"),
+	OPTLINE("--mode MODE", "allows choice of memory/IO trade-offs where MODE is one of:"),
 	OPTLINE("", "original - read inodes and extents to memory (requires more memory, does less IO)"),
 	OPTLINE("", "lowmem   - try to use less memory but read blocks again when needed"),
 	"",
@@ -10594,7 +10594,7 @@ static const char * const cmd_check_usage[] = {
 	"Check and reporting options:",
 	OPTLINE("--check-data-csum", "verify checksums of data blocks"),
 	OPTLINE("-Q, --qgroup-report", "print a report on qgroup consistency"),
-	OPTLINE("-E, --subvol-extents <subvolid>", "print subvolume extents and sharing state"),
+	OPTLINE("-E, --subvol-extents SUBVOLID", "print subvolume extents and sharing state"),
 	OPTLINE("-p, --progress", "indicate progress"),
 	"",
 	"Deprecated or moved options:",

cmds/inspect-dump-super.c

@@ -88,15 +88,15 @@ static const char * const cmd_inspect_dump_super_usage[] = {
 	"",
 	OPTLINE("-f, --full", "print full superblock information, backup roots etc."),
 	OPTLINE("-a, --all", "print information about all superblocks"),
-	OPTLINE("-s, --super <super>", "specify which copy to print out (values: 0, 1, 2)"),
+	OPTLINE("-s, --super NUMBER", "specify which copy to print out (values: 0, 1, 2)"),
 	OPTLINE("-F, --force", "attempt to dump superblocks with bad magic"),
-	OPTLINE("--bytenr <offset>", "specify alternate superblock offset"),
+	OPTLINE("--bytenr BYTENR", "specify alternate superblock offset"),
 	"",
 	"Deprecated syntax:",
-	OPTLINE("-s <bytenr>", "specify alternate superblock offset, values other than 0, 1, 2 "
+	OPTLINE("-s BYTENR", "specify alternate superblock offset, values other than 0, 1, 2 "
 		"will be interpreted as --bytenr for backward compatibility, "
 		"option renamed for consistency with other tools (eg. check)"),
-	OPTLINE("-i <super>", "specify which copy to print out (values: 0, 1, 2), now moved to --super"),
+	OPTLINE("-i NUMBER", "specify which copy to print out (values: 0, 1, 2), now moved to --super"),
 	NULL
 };
 

cmds/inspect-dump-tree.c

@@ -153,7 +153,7 @@ static const char * const cmd_inspect_dump_tree_usage[] = {
 	OPTLINE("-R, --backups", "same as --roots plus print backup root info"),
 	OPTLINE("-u, --uuid", "print only the uuid tree"),
 	OPTLINE("-b, --block <block_num>", "print info from the specified block only can be specified multiple times"),
-	OPTLINE("-t, --tree <tree_id>", "print only tree with the given id (string or number)"),
+	OPTLINE("-t, --tree TREEID", "print only tree with the given id (string or number)"),
 	OPTLINE("--follow", "use with -b, to show all children tree blocks of <block_num>"),
 	OPTLINE("--noscan", "do not scan the devices from the filesystem, use only the listed ones"),
 	OPTLINE("--bfs", "breadth-first traversal of the trees, print nodes, then leaves (default)"),

cmds/inspect-tree-stats.c

@@ -442,7 +442,7 @@ static const char * const cmd_inspect_tree_stats_usage[] = {
 	"",
 	OPTLINE("-b", "raw numbers in bytes"),
 	HELPINFO_UNITS_LONG,
-	OPTLINE("-t <tree_id>", "print only tree with the given id (string or number)"),
+	OPTLINE("-t TREEID", "print only tree with the given id (string or number)"),
 	NULL
 };
 

cmds/property.c

@@ -593,7 +593,7 @@ static const char * const cmd_property_get_usage[] = {
 	"Possible values for type are: inode, subvol, filesystem, device.",
 	"They can be abbreviated to the first letter, i/s/f/d",
 	"",
-	OPTLINE("-t <TYPE>", "list properties for the given object type (inode, subvol, filesystem, device)"),
+	OPTLINE("-t TYPE", "list properties for the given object type (inode, subvol, filesystem, device)"),
 	NULL
 };
 
@@ -624,7 +624,7 @@ static const char * const cmd_property_set_usage[] = {
 	"Set a property on a btrfs object where object is a path to file or",
 	"directory and can also represent the filesystem or device based on the type",
 	"",
-	OPTLINE("-t <TYPE>", "list properties for the given object type (inode, subvol, filesystem, device)"),
+	OPTLINE("-t TYPE", "list properties for the given object type (inode, subvol, filesystem, device)"),
 	OPTLINE("-f", "force the change, could potentially break something"),
 	NULL
 };
@@ -655,7 +655,7 @@ static const char * const cmd_property_list_usage[] = {
 	"See the help of 'btrfs property get' for a description of",
 	"objects and object types.",
 	"",
-	OPTLINE("-t <TYPE>", "list properties for the given object type (inode, subvol, filesystem, device)"),
+	OPTLINE("-t TYPE", "list properties for the given object type (inode, subvol, filesystem, device)"),
 	NULL
 };
 

cmds/receive.c

@@ -1648,7 +1648,7 @@ static const char * const cmd_receive_usage[] = {
 	"",
 	OPTLINE("-q, --quiet", "suppress all messages, except errors"),
 	OPTLINE("-f FILE", "read the stream from FILE instead of stdin"),
-	OPTLINE("-e", "terminate after receiving an <end cmd> marker in the stream. "
+	OPTLINE("-e", "terminate after receiving an \"end cmd\" marker in the stream. "
 		"Without this option the receiver side terminates only in case "
 		"of an error on end of file."),
 	OPTLINE("-C, --chroot", "confine the process to <mount> using chroot"),

cmds/rescue.c

@@ -283,7 +283,7 @@ static const char * const cmd_rescue_fix_data_checksum_usage[] = {
 	"",
 	OPTLINE("-r, --readonly", "readonly mode, only report errors without repair"),
 	OPTLINE("-i, --interactive", "interactive mode, ignore the error by default."),
-	OPTLINE("-m, --mirror <mirror>", "update csum item using specified mirror"),
+	OPTLINE("-m, --mirror NUMBER", "update csum item using specified mirror"),
 	HELPINFO_INSERT_GLOBALS,
 	HELPINFO_INSERT_VERBOSE,
 	NULL

cmds/restore.c

@@ -1357,10 +1357,10 @@ static const char * const cmd_restore_usage[] = {
 	OPTLINE("-l, --list-roots", "list tree roots"),
 	"",
 	"Alternate starting point:",
-	OPTLINE("-f <bytenr>", "filesystem location"),
-	OPTLINE("-r, --root <rootid>", "root objectid"),
-	OPTLINE("-t <bytenr>", "tree location"),
-	OPTLINE("-u, --super <mirror>", "super mirror"),
+	OPTLINE("-f BYTENR", "filesystem location"),
+	OPTLINE("-r, --root ROOTID", "root objectid"),
+	OPTLINE("-t BYTENR", "tree location"),
+	OPTLINE("-u, --super NUMBER", "super mirror"),
 	"",
 	"Other:",
 	OPTLINE("-v, --verbose", "deprecated, alias for global -v option"),

cmds/send.c

@@ -475,9 +475,9 @@ static const char * const cmd_send_usage[] = {
 	"clone sources itself.",
 	"",
 	OPTLINE("-e", "if sending multiple subvols at once, use the new format and omit the end-cmd between the subvols"),
-	OPTLINE("-p <parent>", "send an incremental stream from <parent> to <subvol>"),
-	OPTLINE("-c <clone-src>", "Use this snapshot as a clone source for an incremental send (multiple allowed)"),
-	OPTLINE("-f <outfile>", "Output is normally written to stdout. To write to "
+	OPTLINE("-p PARENTID", "send an incremental stream from PARENTID to <subvol>"),
+	OPTLINE("-c CLONEID", "Use this snapshot as a clone source ID for an incremental send (multiple allowed)"),
+	OPTLINE("-f FILE", "Output is normally written to stdout. To write to "
 		"a file, use this option. An alternative would be to use pipes."),
 	OPTLINE("--no-data", "send in NO_FILE_DATA mode, Note: the output stream "
 		"does not contain any file data and thus cannot be used "

cmds/subvolume.c

@@ -134,7 +134,7 @@ static const char * const cmd_subvolume_create_usage[] = {
 	"subvolume <name> will be created in the current directory. Options apply",
 	"to all created subvolumes.",
 	"",
-	OPTLINE("-i <qgroupid>", "add the newly created subvolume(s) to a qgroup. This option can be given multiple times."),
+	OPTLINE("-i QGROUPID", "add the newly created subvolume(s) to a qgroup. This option can be given multiple times."),
 	OPTLINE("-p, --parents", "create any missing parent directories for each argument (like mkdir -p)"),
 	HELPINFO_INSERT_GLOBALS,
 	HELPINFO_INSERT_QUIET,
@@ -640,7 +640,7 @@ static const char * const cmd_subvolume_snapshot_usage[] = {
 	"When only <subdir> is given, the subvolume will be named the basename of <subvolume>.",
 	"",
 	OPTLINE("-r", "make the new snapshot readonly"),
-	OPTLINE("-i <qgroupid>", "Add the new snapshot to a qgroup (a quota group). This option can be given multiple times."),
+	OPTLINE("-i QGROUPID", "Add the new snapshot to a qgroup (a quota group). This option can be given multiple times."),
 	HELPINFO_INSERT_GLOBALS,
 	HELPINFO_INSERT_QUIET,
 	NULL
@@ -1711,7 +1711,7 @@ static const char * const cmd_subvolume_sync_usage[] = {
 	"are completed, but do not wait for subvolumes deleted meanwhile.",
 	"The status of subvolume ids is checked periodically.",
 	"",
-	OPTLINE("-s <N>", "sleep N seconds between checks (default: 1)"),
+	OPTLINE("-s NUMBER", "sleep N seconds between checks (default: 1)"),
 	NULL
 };