linux-bcache.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Marcin Mirosław" <marcin@mejor.pl>
To: linux-bcache@vger.kernel.org
Cc: "Marcin Mirosław" <marcin@mejor.pl>
Subject: [PATCH v2 3/4] Make --help and man more consistent
Date: Tue, 13 Sep 2016 12:55:43 +0200	[thread overview]
Message-ID: <1473764144-18993-3-git-send-email-marcin@mejor.pl> (raw)
In-Reply-To: <1473764144-18993-1-git-send-email-marcin@mejor.pl>

Options displayed by `bcache format --help` wasn't accepted by bcache. Man bcache is a little bit more descriptive
now.

Signed-off-by: Marcin Mirosław <marcin@mejor.pl>
---
 bcache-format.c | 20 ++++++++++----------
 bcache.8        | 13 +++++++------
 2 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/bcache-format.c b/bcache-format.c
index 1b20b55..c092344 100644
--- a/bcache-format.c
+++ b/bcache-format.c
@@ -75,23 +75,23 @@ static void usage(void)
 	     "Usage: bcache format [OPTION]... <devices>\n"
 	     "\n"
 	     "Options:\n"
-	     "  -b, --block=size\n"
-	     "      --btree_node=size       Btree node size, default 256k\n"
-	     "      --metadata_checksum_type=(none|crc32c|crc64)\n"
-	     "      --data_checksum_type=(none|crc32c|crc64)\n"
-	     "      --compression_type=(none|lz4|gzip)\n"
+	     "  -b, --block=size in bytes               default is highest block size from all formated devices\n"
+	     "      --btree_node_size=size in bytes     Btree node size, default and max supported 256k\n"
+	     "      --metadata_checksum_type=           (none|crc32c [default]|crc64)\n"
+	     "      --data_checksum_type=               (none|crc32c [default]|crc64)\n"
+	     "      --compression_type=                 (none [default]|lz4|gzip)\n"
 	     "      --encrypted\n"
-	     "      --error_action=(continue|readonly|panic)\n"
-	     "                              Action to take on filesystem error\n"
-	     "  -l, --label=label\n"
-	     "      --uuid=uuid\n"
+	     "      --error_action=                     (continue|readonly [default]|panic)\n"
+	     "                                    Action to take on filesystem error\n"
+	     "  -L, --label=label\n"
+	     "  -U, --uuid=uuid\n"
 	     "  -f, --force\n"
 	     "\n"
 	     "Device specific options:\n"
 	     "      --fs_size=size          Size of filesystem on device\n"
 	     "      --bucket=size           bucket size\n"
 	     "      --discard               Enable discards\n"
-	     "  -t, --tier=#                tier of subsequent devices\n"
+	     "  -t, --tier=#                tier level of subsequent devices\n"
 	     "\n"
 	     "  -h, --help                  display this help and exit\n"
 	     "\n"
diff --git a/bcache.8 b/bcache.8
index 7671cf3..14aae3e 100644
--- a/bcache.8
+++ b/bcache.8
@@ -64,12 +64,13 @@ List the bcache commands
 .SH Global options:
 .TP
 .BR \-w,\ --block=
-block size, in bytes (e.g. 4k)
+block size, in bytes (e.g. 4096) - default is highest block size from all formated devices
 .TP
-.BR \-w,\ --btree_node_size=
-btree node size in bytes - default 256k
+.BR \--btree_node_size=
+btree node size in bytes - default and maximum is 256k
 .TP
 .BR \--metadata_checksum_type=TYPE
+where TYPE is one of none, crc32c (default), or crc64
 .TP
 .BR \--data_checksum_type=TYPE
 where TYPE is one of none, crc32c (default), or crc64
@@ -83,10 +84,10 @@ Enable encryption; passphrase will be prompted for
 .BR \--error_action=TYPE
 where TYPE is one of continue, readonly (default) or panic
 .TP
-.BR \-l\ --label=LABEL
+.BR \-L\ --label=LABEL
 Create the filesystem with the specified label
 .TP
-.BR \--uuid=UUID
+.BR \-U\ --uuid=UUID
 Create the filesystem with the specified UUID
 .TP
 .BR \--force
@@ -98,7 +99,7 @@ filesystem
 .BR \--fs_size=SIZE
 Create the filesystem using SIZE bytes on the subsequent device
 .TP
-.BR \-b\ --bucket-size=SIZE
+.BR \--bucket-size=SIZE
 Specifies the bucket size - must be greater than the btree node size
 .TP
 .BR \-t,\ --tier=INDEX
-- 
2.7.3

  parent reply	other threads:[~2016-09-13 10:56 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-13 10:55 [PATCH v2 1/4] Leave choosing level of optimalization and linker flags to package maintainer Marcin Mirosław
2016-09-13 10:55 ` [PATCH v2 2/4] No need to spawn subshell for every source file Marcin Mirosław
2016-09-13 10:55 ` Marcin Mirosław [this message]
2016-09-13 10:55 ` [PATCH v2 4/4] Remove unimplemented options from manpage Marcin Mirosław
2016-09-13 15:33 ` [PATCH v2 1/4] Leave choosing level of optimalization and linker flags to package maintainer Coly Li
2016-09-14  8:39   ` [PATCH v2 1/4][Resend] " Marcin Mirosław

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1473764144-18993-3-git-send-email-marcin@mejor.pl \
    --to=marcin@mejor.pl \
    --cc=linux-bcache@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).