Skip to contentSkip to conversation

nvme-cli: update command message for "help"

PATCH New Minwoo Im 4 participants 5 messages Jun 1, 2019 – Jul 25, 2019 NVMe

lore
Share & tools
lore

Minwoo Im

author
#0 lore raw

PATCH 1/1 nvme-cli: update command message for "help"

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(-)
plugin.c +1 -1
index 4750df6..8fd0605 100644
@@ -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)
Signature · 1 line
2.21.0
maintainer
#1 lore raw

PATCH 1/1 nvme-cli: update command message for "help"

Reviewed-by Sagi Grimberg <sagi at grimberg.me>
#2 lore raw

PATCH 1/1 nvme-cli: update command message for "help"

In reply to Minwoo Im

Looks good to me.

Reviewed-by Chaitanya Kulkarni <chaitanya.kulkarni at wdc.com>
Quoted 24 lines · 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(-)
plugin.c +1 -1
index 4750df6..8fd0605 100644
@@ -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)
maintainer
#3 lore raw

PATCH 1/1 nvme-cli: update command message for "help"

In reply to Minwoo Im
Quoted 4 lines · 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.

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'.

author
#4 lore raw

PATCH 1/1 nvme-cli: update command message for "help"

Quoted 9 lines · Keith Busch
Quoted 4 lines · 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.

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!