feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

feat(esp_console): Added Help command parameter for displaying only specific command

Browse Source
This commit is contained in:
Josef Norgan
2023-07-24 15:29:10 -07:00
committed by Jakob Hasse
parent 42ac85a6a1
commit f317cc55f2
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
components/console/commands.c
View File

@@ -215,8 +215,20 @@ esp_err_t esp_console_run(const char *cmdline, int *cmd_ret)
return ESP_OK; return ESP_OK;
} }
static struct {
struct arg_str *help_cmd;
struct arg_end *end;
} help_args;
static int help_command(int argc, char **argv) static int help_command(int argc, char **argv)
{ {
int nerrors = arg_parse(argc, argv, (void **) &help_args);
if (nerrors != 0) {
arg_print_errors(stderr, help_args.end, argv[0]);
return 1;
}
cmd_item_t *it; cmd_item_t *it;
/* Print summary of each command */ /* Print summary of each command */
@@ -224,6 +236,10 @@ static int help_command(int argc, char **argv)
if (it->help == NULL) { if (it->help == NULL) {
continue; continue;
} }
if (strlen(help_args.help_cmd->sval[0]) > 0 &&
strcmp(help_args.help_cmd->sval[0], it->command) != 0) {
continue;
}
/* First line: command name and hint /* First line: command name and hint
* Pad all the hints to the same column * Pad all the hints to the same column
*/ */
@@ -246,10 +262,14 @@ static int help_command(int argc, char **argv)
esp_err_t esp_console_register_help_command(void) esp_err_t esp_console_register_help_command(void)
{ {
help_args.help_cmd = arg_str0(NULL, NULL, "<string>", "Name of command");
help_args.end = arg_end(1);
esp_console_cmd_t command = { esp_console_cmd_t command = {
.command = "help", .command = "help",
.help = "Print the list of registered commands", .help = "Print the list of registered commands",
.func = &help_command .func = &help_command,
.argtable = &help_args
}; };
return esp_console_cmd_register(&command); return esp_console_cmd_register(&command);
} }