shell: Add optional command description
The command name and a shortened form of valid parameters is not
necessarily enough to understand its usage. Add the option of
providing a more lengthy description of the command usage.
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
diff --git a/include/shell/shell.h b/include/shell/shell.h
index ea982df..54e99bd 100644
--- a/include/shell/shell.h
+++ b/include/shell/shell.h
@@ -29,6 +29,7 @@
const char *cmd_name;
shell_cmd_function_t cb;
const char *help;
+ const char *desc;
};
/** @brief Callback to get the current prompt.
diff --git a/subsys/shell/shell.c b/subsys/shell/shell.c
index b55be0d..fe1394b 100644
--- a/subsys/shell/shell.c
+++ b/subsys/shell/shell.c
@@ -181,7 +181,7 @@
return argv[0];
}
-static int show_cmd_help(char *argv[])
+static int show_cmd_help(char *argv[], bool full)
{
const char *command = NULL;
int module = -1;
@@ -196,10 +196,13 @@
shell_module = &__shell_cmd_start[module];
for (i = 0; shell_module->commands[i].cmd_name; i++) {
if (!strcmp(command, shell_module->commands[i].cmd_name)) {
- printk("%s %s\n",
+ printk("Usage: %s %s\n",
shell_module->commands[i].cmd_name,
shell_module->commands[i].help ?
shell_module->commands[i].help : "");
+ if (full && shell_module->commands[i].desc) {
+ printk("%s\n", shell_module->commands[i].desc);
+ }
return 0;
}
}
@@ -229,7 +232,7 @@
/* help per command */
if ((argc > 2) || ((default_module != -1) && (argc == 2))) {
- return show_cmd_help(&argv[1]);
+ return show_cmd_help(&argv[1], true);
}
/* help per module */
@@ -385,7 +388,7 @@
}
if (err < 0) {
- show_cmd_help(argv);
+ show_cmd_help(argv, false);
}
return err;
