Doc/examples: clarify usage messages

[openocd.git] / src / hello.c

diff --git a/src/hello.c b/src/hello.c
index dd33650dcf004272e6a969b61e31dd866f3584b5..8cd5fabb47c4a50f1161503befd9c2baed0a54d1 100644 (file)
--- a/src/hello.c
+++ b/src/hello.c
@@ -20,7 +20,63 @@
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
-#include "log.h"
+#include <helper/log.h>
+
+COMMAND_HANDLER(handle_foo_command)
+{
+       if (CMD_ARGC < 1 || CMD_ARGC > 2)
+       {
+               LOG_ERROR("%s: incorrect number of arguments", CMD_NAME);
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+
+       uint32_t address;
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
+
+       const char *msg = "<unchanged>";
+       if (CMD_ARGC == 2)
+       {
+               bool enable;
+               COMMAND_PARSE_ENABLE(CMD_ARGV[1], enable);
+               msg = enable ? "enable" : "disable";
+       }
+
+       LOG_INFO("%s: address=0x%8.8" PRIx32 " enabled=%s", CMD_NAME, address, msg);
+       return ERROR_OK;
+}
+
+static bool foo_flag;
+
+COMMAND_HANDLER(handle_flag_command)
+{
+       return CALL_COMMAND_HANDLER(handle_command_parse_bool,
+                       &foo_flag, "foo flag");
+}
+
+static const struct command_registration foo_command_handlers[] = {
+       {
+               .name = "bar",
+               .handler = &handle_foo_command,
+               .mode = COMMAND_ANY,
+               .usage = "address ['enable'|'disable']",
+               .help = "an example command",
+       },
+       {
+               .name = "baz",
+               .handler = &handle_foo_command,
+               .mode = COMMAND_ANY,
+               .usage = "address ['enable'|'disable']",
+               .help = "a sample command",
+       },
+       {
+               .name = "flag",
+               .handler = &handle_flag_command,
+               .mode = COMMAND_ANY,
+               .usage = "[on|off]",
+               .help = "set a flag",
+       },
+       COMMAND_REGISTRATION_DONE
+};
 
 static COMMAND_HELPER(handle_hello_args, const char **sep, const char **name)
 {
@@ -48,10 +104,25 @@ COMMAND_HANDLER(handle_hello_command)
        return retval;
 }
 
+const struct command_registration hello_command_handlers[] = {
+       {
+               .name = "hello",
+               .handler = handle_hello_command,
+               .mode = COMMAND_ANY,
+               .help = "prints a warm welcome",
+               .usage = "[name]",
+       },
+       {
+               .name = "foo",
+               .mode = COMMAND_ANY,
+               .help = "example command handler skeleton",
+
+               .chain = foo_command_handlers,
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
 int hello_register_commands(struct command_context *cmd_ctx)
 {
-       struct command *cmd = register_command(cmd_ctx, NULL, "hello",
-                       &handle_hello_command, COMMAND_ANY,
-                       "option");
-       return cmd ? ERROR_OK : -ENOMEM;
+       return register_commands(cmd_ctx, NULL, hello_command_handlers);
 }