patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

shell: Add optional command description

Browse source 
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>
This commit is contained in:
Johan Hedberg 2017-11-14 15:51:40 +02:00 committed by Johan Hedberg
parent a57f26c673
commit 7f6070fb6c
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
include/shell/shell.h
View file

@ -29,6 +29,7 @@ struct shell_cmd {
const char *cmd_name;
shell_cmd_function_t cb;
const char *help;
const char *desc;
};
/** @brief Callback to get the current prompt.

11
subsys/shell/shell.c
View file

@ -181,7 +181,7 @@ static const char *get_command_and_module(char *argv[], int *module)
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 @@ static int show_cmd_help(char *argv[])
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 @@ static int show_help(int argc, char *argv[])
/* 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 @@ int shell_exec(char *line)
}
if (err < 0) {
show_cmd_help(argv);
show_cmd_help(argv, false);
}
return err;