target/arc: fix command's usage string 22/5822/2
authorAntonio Borneo <borneo.antonio@gmail.com>
Sat, 22 Aug 2020 23:28:38 +0000 (01:28 +0200)
committerAntonio Borneo <borneo.antonio@gmail.com>
Sat, 5 Sep 2020 16:13:00 +0000 (17:13 +0100)
The usage string should contain only the command parameters.
OpenOCD will automatically prepend the command name to the usage
string while dumping the usage or help message.

Remove the repeated command name from the usage string.

Change-Id: I691094a6395acb0e4ea3bea2347ff38379002464
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/5822
Tested-by: jenkins
src/target/arc_cmd.c

index 36babc768d66476849aad77ccb8e224a0b48c2dc..18f5cb8f40fce77a7f97abbeb41d549b0612ec6e 100644 (file)
@@ -451,7 +451,7 @@ static const struct command_registration arc_jtag_command_group[] = {
                        "raw JTAG request that bypasses OpenOCD register cache "
                        "and thus is unsafe and can have unexpected consequences. "
                        "Use at your own risk.",
-               .usage = "arc jtag get-aux-reg <regnum>"
+               .usage = "<regnum>"
        },
        {
                .name = "set-aux-reg",
@@ -461,7 +461,7 @@ static const struct command_registration arc_jtag_command_group[] = {
                        "raw JTAG request that bypasses OpenOCD register cache "
                        "and thus is unsafe and can have unexpected consequences. "
                        "Use at your own risk.",
-               .usage = "arc jtag set-aux-reg <regnum> <value>"
+               .usage = "<regnum> <value>"
        },
        {
                .name = "get-core-reg",
@@ -471,7 +471,7 @@ static const struct command_registration arc_jtag_command_group[] = {
                        "raw JTAG request that bypasses OpenOCD register cache "
                        "and thus is unsafe and can have unexpected consequences. "
                        "Use at your own risk.",
-               .usage = "arc jtag get-core-reg <regnum> [<value>]"
+               .usage = "<regnum> [<value>]"
        },
        {
                .name = "set-core-reg",
@@ -481,7 +481,7 @@ static const struct command_registration arc_jtag_command_group[] = {
                        "raw JTAG request that bypasses OpenOCD register cache "
                        "and thus is unsafe and can have unexpected consequences. "
                        "Use at your own risk.",
-               .usage = "arc jtag set-core-reg <regnum> [<value>]"
+               .usage = "<regnum> [<value>]"
        },
        COMMAND_REGISTRATION_DONE
 };
@@ -1010,7 +1010,7 @@ static const struct command_registration arc_core_command_handlers[] = {
                .name = "add-reg-type-flags",
                .jim_handler = jim_arc_add_reg_type_flags,
                .mode = COMMAND_CONFIG,
-               .usage = "arc ardd-reg-type-flags -name <string> -flag <name> <position> "
+               .usage = "-name <string> -flag <name> <position> "
                        "[-flag <name> <position>]...",
                .help = "Add new 'flags' register data type. Only single bit flags "
                        "are supported. Type name is global. Bitsize of register is fixed "
@@ -1020,7 +1020,7 @@ static const struct command_registration arc_core_command_handlers[] = {
                .name = "add-reg-type-struct",
                .jim_handler = jim_arc_add_reg_type_struct,
                .mode = COMMAND_CONFIG,
-               .usage = "arc add-reg-type-struct -name <string> -bitfield <name> <start> <end> "
+               .usage = "-name <string> -bitfield <name> <start> <end> "
                        "[-bitfield <name> <start> <end>]...",
                .help = "Add new 'struct' register data type. Only bit-fields are "
                        "supported so far, which means that for each bitfield start and end "
@@ -1032,7 +1032,7 @@ static const struct command_registration arc_core_command_handlers[] = {
                .name = "add-reg",
                .jim_handler = jim_arc_add_reg,
                .mode = COMMAND_CONFIG,
-               .usage = "arc add-reg -name <string> -num <int> -feature <string> [-gdbnum <int>] "
+               .usage = "-name <string> -num <int> -feature <string> [-gdbnum <int>] "
                        "[-core|-bcr] [-type <type_name>] [-g]",
                .help = "Add new register. Name, architectural number and feature name "
                        "are required options. GDB regnum will default to previous register "
@@ -1043,7 +1043,7 @@ static const struct command_registration arc_core_command_handlers[] = {
                .name = "set-reg-exists",
                .handler = arc_set_reg_exists,
                .mode = COMMAND_ANY,
-               .usage = "arc set-reg-exists <register-name> [<register-name>]...",
+               .usage = "<register-name> [<register-name>]...",
                .help = "Set that register exists. Accepts multiple register names as "
                        "arguments.",
        },
@@ -1051,7 +1051,7 @@ static const struct command_registration arc_core_command_handlers[] = {
                .name = "get-reg-field",
                .jim_handler = jim_arc_get_reg_field,
                .mode = COMMAND_ANY,
-               .usage = "arc get-reg-field <regname> <field_name>",
+               .usage = "<regname> <field_name>",
                .help = "Returns value of field in a register with 'struct' type.",
        },
        {
@@ -1083,7 +1083,7 @@ const struct command_registration arc_monitor_command_handlers[] = {
                .name = "arc",
                .mode = COMMAND_ANY,
                .help = "ARC monitor command group",
-               .usage = "Help info ...",
+               .usage = "",
                .chain = arc_core_command_handlers,
        },
        COMMAND_REGISTRATION_DONE

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)