[GitHub] michal-narajowski closed pull request #1014: sys/shell: Improve command help information

[GitBox <gi...@apache.org>]

michal-narajowski closed pull request #1014: sys/shell: Improve command help information
URL: https://github.com/apache/mynewt-core/pull/1014
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/sys/shell/src/shell.c b/sys/shell/src/shell.c
index 09f199b61..d95ef4b47 100644
--- a/sys/shell/src/shell.c
+++ b/sys/shell/src/shell.c
@@ -173,12 +173,30 @@ get_command_and_module(char *argv[], int *module)
     return argv[0];
 }
 
+static void
+print_command_params(const int module, const int command)
+{
+	const struct shell_module *shell_module = &shell_modules[module];
+	const struct shell_cmd *shell_cmd = &shell_module->commands[command];
+	int i;
+
+	if (!(shell_cmd->help && shell_cmd->help->params)) {
+		return;
+	}
+
+	for (i = 0; shell_cmd->help->params[i].param_name; i++) {
+		console_printf("%-30s%s\n", shell_cmd->help->params[i].param_name,
+			       shell_cmd->help->params[i].help);
+	}
+}
+
 static int
 show_cmd_help(char *argv[])
 {
     const char *command = NULL;
     int module = -1;
     const struct shell_module *shell_module = NULL;
+    const struct shell_cmd *cmd;
     int i;
 
     command = get_command_and_module(argv, &module);
@@ -188,21 +206,30 @@ show_cmd_help(char *argv[])
 
     shell_module = &shell_modules[module];
     for (i = 0; shell_module->commands[i].sc_cmd; i++) {
-        if (!strcmp(command, shell_module->commands[i].sc_cmd)) {
-            console_printf("%s:\n", shell_module->commands[i].sc_cmd);
+        cmd = &shell_module->commands[i];
+
+        if (!strcmp(command, cmd->sc_cmd)) {
 
-            if (!shell_module->commands[i].help) {
+            if (!cmd->help || (!cmd->help->summary &&
+                               !cmd->help->usage &&
+                               !cmd->help->params)) {
                 console_printf("(no help available)\n");
                 return 0;
             }
-            if (shell_module->commands[i].help->usage) {
-                console_printf("%s:\n", shell_module->commands[i].sc_cmd);
-                console_printf("%s\n", shell_module->commands[i].help->usage);
-            } else if (shell_module->commands[i].help->summary) {
-                console_printf("%s:\n", shell_module->commands[i].sc_cmd);
-                console_printf("%s\n", shell_module->commands[i].help->summary);
-            } else {
-                console_printf("(no help available)\n");
+
+            if (cmd->help->summary) {
+                console_printf("Summary:\n");
+                console_printf("%s\n", cmd->help->summary);
+            }
+
+            if (cmd->help->usage) {
+                console_printf("Usage:\n");
+                console_printf("%s\n", cmd->help->usage);
+            }
+
+            if (cmd->help->params) {
+                console_printf("Parameters:\n");
+                print_command_params(module, i);
             }
 
             return 0;
@@ -435,23 +462,6 @@ shell(struct os_event *ev)
 }
 
 #if MYNEWT_VAL(SHELL_COMPLETION)
-static void
-print_command_params(const int module, const int command)
-{
-    const struct shell_module *shell_module = &shell_modules[module];
-    const struct shell_cmd *shell_cmd = &shell_module->commands[command];
-    int i;
-
-    if (!(shell_cmd->help && shell_cmd->help->params)) {
-        return;
-    }
-
-    for (i = 0; shell_cmd->help->params[i].param_name; i++) {
-        console_printf("%-30s%s\n", shell_cmd->help->params[i].param_name,
-                       shell_cmd->help->params[i].help);
-    }
-}
-
 static int
 get_command_from_module(const char *command, int len, int module)
 {


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services