[PATCH] nvme-cli: update command message for "help"

[PATCH] nvme-cli: update command message for "help"

[Minwoo Im]

The "help" subcommand will show the man page, not the help message which
is printed out to stdout by --help option.  The previous message might
make confusions between man page and --help options so that it needs to
be updated.

Cc: Keith Busch <kbusch at kernel.org>
Signed-off-by: Minwoo Im <minwoo.im.dev at gmail.com>
---
 plugin.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/plugin.c b/plugin.c
index 4750df6..8fd0605 100644
--- a/plugin.c
+++ b/plugin.c
@@ -91,7 +91,7 @@ void general_help(struct plugin *plugin)
 					plugin->commands[i]->help);
 
 	printf("  %-*s %s\n", padding, "version", "Shows the program version");
-	printf("  %-*s %s\n", padding, "help", "Display this help");
+	printf("  %-*s %s\n", padding, "help", "Display the man page");
 	printf("\n");
 
 	if (plugin->name)
-- 
2.21.0

[PATCH] nvme-cli: update command message for "help"

[Sagi Grimberg]

Reviewed-by: Sagi Grimberg <sagi at grimberg.me>

[PATCH] nvme-cli: update command message for "help"

[Chaitanya Kulkarni]

Looks good to me.

Reviewed-by: Chaitanya Kulkarni <chaitanya.kulkarni at wdc.com>

On 5/31/19 10:55 PM, Minwoo Im wrote:
> The "help" subcommand will show the man page, not the help message which
> is printed out to stdout by --help option.  The previous message might
> make confusions between man page and --help options so that it needs to
> be updated.
>
> Cc: Keith Busch <kbusch at kernel.org>
> Signed-off-by: Minwoo Im <minwoo.im.dev at gmail.com>
> ---
>  plugin.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/plugin.c b/plugin.c
> index 4750df6..8fd0605 100644
> --- a/plugin.c
> +++ b/plugin.c
> @@ -91,7 +91,7 @@ void general_help(struct plugin *plugin)
>  					plugin->commands[i]->help);
>  
>  	printf("  %-*s %s\n", padding, "version", "Shows the program version");
> -	printf("  %-*s %s\n", padding, "help", "Display this help");
> +	printf("  %-*s %s\n", padding, "help", "Display the man page");
>  	printf("\n");
>  
>  	if (plugin->name)

[PATCH] nvme-cli: update command message for "help"

[Keith Busch]

On Sat, Jun 01, 2019@02:54:28PM +0900, Minwoo Im wrote:
> The "help" subcommand will show the man page, not the help message which
> is printed out to stdout by --help option.  The previous message might
> make confusions between man page and --help options so that it needs to
> be updated.

If you just type "nvme help", you get that help message. If you type
"nvme help <command>", then you get that command's manpage. This
behavior was copied from 'git'.

[PATCH] nvme-cli: update command message for "help"

[Minwoo Im]

On 19-07-24 11:17:45, Keith Busch wrote:
> On Sat, Jun 01, 2019@02:54:28PM +0900, Minwoo Im wrote:
> > The "help" subcommand will show the man page, not the help message which
> > is printed out to stdout by --help option.  The previous message might
> > make confusions between man page and --help options so that it needs to
> > be updated.
> 
> If you just type "nvme help", you get that help message. If you type
> "nvme help <command>", then you get that command's manpage. This
> behavior was copied from 'git'.

Hi Keith,

Yes, That's what I meant in this patch, but it does not look like cover
"nvme help" command itself.

Let's keep it that way, then.

Thanks!