FreeBSD build fixes
[fw/openocd] / src / helper / command.c
index b4e31ea1a7e1d2a3a975ad5515999dcd1fd14306..568596d17b96afe4c92bd30aef2f44eb8988ad2c 100644 (file)
@@ -914,7 +914,7 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
        bool is_match = (strstr(cmd_name, match) != NULL) ||
        ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) ||
        ((c->help != NULL) && (strstr(c->help, match) != NULL));
-       
+
        if (is_match)
        {
                command_help_show_indent(n);
@@ -934,15 +934,27 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 
        if (is_match && show_help)
        {
-               const char *stage_msg;
-               switch (c->mode) {
-               case COMMAND_CONFIG: stage_msg = "CONFIG"; break;
-               case COMMAND_EXEC: stage_msg = "EXEC"; break;
-               case COMMAND_ANY: stage_msg = "CONFIG or EXEC"; break;
-               default: stage_msg = "***UNKNOWN***"; break;
-               }
-               char *msg = alloc_printf("%s%sValid Modes: %s",
-                       c->help ? : "", c->help ? "  " : "", stage_msg);
+               char *msg;
+
+               /* Normal commands are runtime-only; highlight exceptions */
+               if (c->mode != COMMAND_EXEC) {
+                       const char *stage_msg = "";
+
+                       switch (c->mode) {
+                       case COMMAND_CONFIG:
+                               stage_msg = " (configuration command)";
+                               break;
+                       case COMMAND_ANY:
+                               stage_msg = " (command valid any time)";
+                               break;
+                       default:
+                               stage_msg = " (?mode error?)";
+                               break;
+                       }
+                       msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
+               } else
+                       msg = alloc_printf("%s", c->help ? : "");
+
                if (NULL != msg)
                {
                        command_help_show_wrap(msg, n + 3, n + 3);
@@ -1075,6 +1087,7 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        struct command_context *cmd_ctx = current_command_context(interp);
        enum command_mode mode;
+
        if (argc > 1)
        {
                struct command *c = cmd_ctx->commands;
@@ -1211,7 +1224,7 @@ COMMAND_HANDLER(handle_help_add_command)
        return help_add_command(CMD_CTX, c, cmd_name, help, usage);
 }
 
-/* sleep command sleeps for <n> miliseconds
+/* sleep command sleeps for <n> milliseconds
  * this is useful in target startup scripts
  */
 COMMAND_HANDLER(handle_sleep_command)
@@ -1251,19 +1264,22 @@ static const struct command_registration command_subcommand_handlers[] = {
        {
                .name = "mode",
                .mode = COMMAND_ANY,
-               .jim_handler = &jim_command_mode,
-               .usage = "[<name> ...]",
+               .jim_handler = jim_command_mode,
+               .usage = "[command_name ...]",
                .help = "Returns the command modes allowed by a  command:"
                        "'any', 'config', or 'exec'.  If no command is"
-                       "specified, returns the current command mode.",
+                       "specified, returns the current command mode.  "
+                       "Returns 'unknown' if an unknown command is given. "
+                       "Command can be multiple tokens.",
        },
        {
                .name = "type",
                .mode = COMMAND_ANY,
-               .jim_handler = &jim_command_type,
-               .usage = "<name> ...",
+               .jim_handler = jim_command_type,
+               .usage = "command_name [...]",
                .help = "Returns the type of built-in command:"
-                       "'native', 'simple', 'group', or 'unknown'",
+                       "'native', 'simple', 'group', or 'unknown'. "
+                       "Command can be multiple tokens.",
        },
        COMMAND_REGISTRATION_DONE
 };
@@ -1271,39 +1287,43 @@ static const struct command_registration command_subcommand_handlers[] = {
 static const struct command_registration command_builtin_handlers[] = {
        {
                .name = "add_help_text",
-               .handler = &handle_help_add_command,
+               .handler = handle_help_add_command,
                .mode = COMMAND_ANY,
-               .help = "add new command help text",
-               .usage = "<command> [...] <help_text>]",
+               .help = "Add new command help text; "
+                       "Command can be multiple tokens.",
+               .usage = "command_name helptext_string",
        },
        {
                .name = "add_usage_text",
-               .handler = &handle_help_add_command,
+               .handler = handle_help_add_command,
                .mode = COMMAND_ANY,
-               .help = "add new command usage text",
-               .usage = "<command> [...] <usage_text>]",
+               .help = "Add new command usage text; "
+                       "command can be multiple tokens.",
+               .usage = "command_name usage_string",
        },
        {
                .name = "sleep",
-               .handler = &handle_sleep_command,
+               .handler = handle_sleep_command,
                .mode = COMMAND_ANY,
-               .help = "sleep for n milliseconds.  "
-                       "\"busy\" will busy wait",
-               .usage = "<n> [busy]",
+               .help = "Sleep for specified number of milliseconds.  "
+                       "\"busy\" will busy wait instead (avoid this).",
+               .usage = "milliseconds ['busy']",
        },
        {
                .name = "help",
-               .handler = &handle_help_command,
+               .handler = handle_help_command,
                .mode = COMMAND_ANY,
-               .help = "show full command help",
-               .usage = "[<command> ...]",
+               .help = "Show full command help; "
+                       "command can be multiple tokens.",
+               .usage = "[command_name]",
        },
        {
                .name = "usage",
-               .handler = &handle_help_command,
+               .handler = handle_help_command,
                .mode = COMMAND_ANY,
-               .help = "show basic command usage",
-               .usage = "[<command> ...]",
+               .help = "Show basic command usage; "
+                       "command can be multiple tokens.",
+               .usage = "[command_name]",
        },
        {
                .name = "command",
@@ -1338,6 +1358,7 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp
 #endif
        context->interp = interp;
 
+       /* Stick to lowercase for HostOS strings. */
 #if defined(_MSC_VER)
        /* WinXX - is generic, the forward
         * looking problem is this:
@@ -1349,7 +1370,7 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp
        HostOs = "winxx";
 #elif defined(__linux__)
        HostOs = "linux";
-#elif defined(__DARWIN__)
+#elif defined(__APPLE__) || defined(__DARWIN__)
        HostOs = "darwin";
 #elif defined(__CYGWIN__)
        HostOs = "cygwin";
@@ -1357,8 +1378,10 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp
        HostOs = "mingw32";
 #elif defined(__ECOS)
        HostOs = "ecos";
+#elif defined(__FreeBSD__)
+       HostOs = "freebsd";
 #else
-#warn unrecognized host OS...
+#warning "Unrecognized host OS..."
        HostOs = "other";
 #endif
        Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",