drivers/sysfsgpio: fix usage messages 33/4833/2
authorAntonio Borneo <borneo.antonio@gmail.com>
Fri, 4 Jan 2019 17:08:20 +0000 (18:08 +0100)
committerTomas Vanek <vanekt@fbl.cz>
Mon, 14 Jan 2019 08:45:35 +0000 (08:45 +0000)
The notation "(tck tms tdi tdo)* " is incorrect, because it means the
quadruple of gpio can be repeated on the command-line.
The correct syntax of the command requires instead to provide either
all the four gpio numbers (in order to set the values) or to pass an
empty command-line (to dump the values previously set).

Change the .usage field to "[tck tms tdi tdo]".
Change similarly the corresponding .usage field for SWD command.
Add the .usage field for the commands that individually set each gpio.

Change-Id: If5b3c618097b71dfe7fcf988fb3c1499ae03a6d5
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/4833
Tested-by: jenkins
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
src/jtag/drivers/sysfsgpio.c

index 24dc4bc..90e93f5 100644 (file)
@@ -457,62 +457,70 @@ static const struct command_registration sysfsgpio_command_handlers[] = {
                .handler = &sysfsgpio_handle_jtag_gpionums,
                .mode = COMMAND_CONFIG,
                .help = "gpio numbers for tck, tms, tdi, tdo. (in that order)",
-               .usage = "(tck tms tdi tdo)* ",
+               .usage = "[tck tms tdi tdo]",
        },
        {
                .name = "sysfsgpio_tck_num",
                .handler = &sysfsgpio_handle_jtag_gpionum_tck,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for tck.",
+               .usage = "[tck]",
        },
        {
                .name = "sysfsgpio_tms_num",
                .handler = &sysfsgpio_handle_jtag_gpionum_tms,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for tms.",
+               .usage = "[tms]",
        },
        {
                .name = "sysfsgpio_tdo_num",
                .handler = &sysfsgpio_handle_jtag_gpionum_tdo,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for tdo.",
+               .usage = "[tdo]",
        },
        {
                .name = "sysfsgpio_tdi_num",
                .handler = &sysfsgpio_handle_jtag_gpionum_tdi,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for tdi.",
+               .usage = "[tdi]",
        },
        {
                .name = "sysfsgpio_srst_num",
                .handler = &sysfsgpio_handle_jtag_gpionum_srst,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for srst.",
+               .usage = "[srst]",
        },
        {
                .name = "sysfsgpio_trst_num",
                .handler = &sysfsgpio_handle_jtag_gpionum_trst,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for trst.",
+               .usage = "[trst]",
        },
        {
                .name = "sysfsgpio_swd_nums",
                .handler = &sysfsgpio_handle_swd_gpionums,
                .mode = COMMAND_CONFIG,
                .help = "gpio numbers for swclk, swdio. (in that order)",
-               .usage = "(swclk swdio)* ",
+               .usage = "[swclk swdio]",
        },
        {
                .name = "sysfsgpio_swclk_num",
                .handler = &sysfsgpio_handle_swd_gpionum_swclk,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for swclk.",
+               .usage = "[swclk]",
        },
        {
                .name = "sysfsgpio_swdio_num",
                .handler = &sysfsgpio_handle_swd_gpionum_swdio,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for swdio.",
+               .usage = "[swdio]",
        },
        COMMAND_REGISTRATION_DONE
 };