summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.com>2016-11-04 14:13:15 +0100
committerDavid Sterba <dsterba@suse.com>2016-11-09 13:47:34 +0100
commit9e0dd182b4fb8ca87c47c256c25a43b6505cc45b (patch)
treeee9786b8ca867f277a1a17d37e55525a059b53d1
parentd75ea3ca873e43e629fe71cf789efe93c8e2636e (diff)
btrfs-progs: docs: update mkfs help string and manual page
Signed-off-by: David Sterba <dsterba@suse.com>
-rw-r--r--Documentation/mkfs.btrfs.asciidoc20
-rw-r--r--mkfs.c30
2 files changed, 19 insertions, 31 deletions
diff --git a/Documentation/mkfs.btrfs.asciidoc b/Documentation/mkfs.btrfs.asciidoc
index 6515e145..9b1d45a5 100644
--- a/Documentation/mkfs.btrfs.asciidoc
+++ b/Documentation/mkfs.btrfs.asciidoc
@@ -7,25 +7,7 @@ mkfs.btrfs - create a btrfs filesystem
SYNOPSIS
--------
-*mkfs.btrfs*
-$$[-A|--alloc-start <alloc-start>]$$
-$$[-b|--byte-count <byte-count>]$$
-$$[-d|--data <data-profile>]$$
-$$[-m|--metadata <metadata profile>]$$
-$$[-M|--mixed]$$
-$$[-l|--leafsize <leafsize>]$$
-$$[-n|--nodesize <nodesize>]$$
-$$[-s|--sectorsize <sectorsize>]$$
-$$[-L|--label <label>]$$
-$$[-K|--nodiscard]$$
-$$[-r|--rootdir <rootdir>]$$
-$$[-O|--features <feature1>[,<feature2>...]]$$
-$$[-U|--uuid <UUID>]$$
-$$[-f|--force]$$
-$$[-q|--quiet]$$
-$$[--help]$$
-$$[-V|--version]$$
-$$<device> [<device>...]$$
+*mkfs.btrfs* [options] <device> [<device>...]
DESCRIPTION
-----------
diff --git a/mkfs.c b/mkfs.c
index 33d43c52..baff7067 100644
--- a/mkfs.c
+++ b/mkfs.c
@@ -344,24 +344,30 @@ static int create_data_reloc_tree(struct btrfs_trans_handle *trans,
static void print_usage(int ret)
{
- printf("usage: mkfs.btrfs [options] dev [ dev ... ]\n");
- printf("options:\n");
- printf("\t-A|--alloc-start START the offset to start the FS\n");
- printf("\t-b|--byte-count SIZE total number of bytes in the FS\n");
+ printf("Usage: mkfs.btrfs [options] dev [ dev ... ]\n");
+ printf("Options:\n");
+ printf(" allocation profiles:\n");
printf("\t-d|--data PROFILE data profile, raid0, raid1, raid5, raid6, raid10, dup or single\n");
- printf("\t-f|--force force overwrite of existing filesystem\n");
- printf("\t-l|--leafsize SIZE deprecated, alias for nodesize\n");
- printf("\t-L|--label LABEL set a label\n");
- printf("\t-m|--metadata PROFILE metadata profile, values like data profile\n");
+ printf("\t-m|--metadata PROFILE metadata profile, values like for data profile\n");
printf("\t-M|--mixed mix metadata and data together\n");
+ printf(" features:\n");
printf("\t-n|--nodesize SIZE size of btree nodes\n");
- printf("\t-s|--sectorsize SIZE min block allocation (may not mountable by current kernel)\n");
- printf("\t-r|--rootdir DIR the source directory\n");
+ printf("\t-s|--sectorsize SIZE data block size (may not be mountable by current kernel)\n");
+ printf("\t-O|--features LIST comma separated list of filesystem features (use '-O list-all' to list features)\n");
+ printf("\t-L|--label LABEL set the filesystem label\n");
+ printf("\t-U|--uuid UUID specify the filesystem UUID (must be unique)\n");
+ printf(" creation:\n");
+ printf("\t-b|--byte-count SIZE set filesystem size to SIZE (on the first device)\n");
+ printf("\t-r|--rootdir DIR copy files from DIR to the image root directory\n");
printf("\t-K|--nodiscard do not perform whole device TRIM\n");
- printf("\t-O|--features LIST comma separated list of filesystem features, use '-O list-all' to list features\n");
- printf("\t-U|--uuid UUID specify the filesystem UUID\n");
+ printf("\t-f|--force force overwrite of existing filesystem\n");
+ printf(" general:\n");
printf("\t-q|--quiet no messages except errors\n");
printf("\t-V|--version print the mkfs.btrfs version and exit\n");
+ printf("\t--help print this help and exit\n");
+ printf(" deprecated:\n");
+ printf("\t-A|--alloc-start START the offset to start the filesytem\n");
+ printf("\t-l|--leafsize SIZE deprecated, alias for nodesize\n");
exit(ret);
}