From f1f532084a6e9ee8225f047353999b459455df7e Mon Sep 17 00:00:00 2001 From: Holger Schurig Date: Tue, 13 May 2014 10:28:42 +0200 Subject: commands: harmonize in-barebox documentation This patch does probably too much, but it's hard (and very cumbersome/time consuming) to break it out. What is does is this: * each command has one short description, e.g. "list MUX configuration" * made sure the short descriptions start lowercase * each command has one usage. That string contains just the options, e.g. "[-npn]". It's not part of the long help text. * that is, it doesn't say "[OPTIONS]" anymore, every usable option is listed by character in this (short) option string (the long description is in the long help text, as before) * help texts have been reworked, to make them - sometimes smaller - sometimes describe the options better - more often present themselves in a nicer format * all long help texts are now created with BUSYBOX_CMD_HELP_ macros, no more 'static const __maybe_unused char cmd_foobar_help[]' * made sure the long help texts starts uppercase * because cmdtp->name and cmdtp->opts together provide the new usage, all "Usage: foobar" texts have been removed from the long help texts * BUSYBOX_CMD_HELP_TEXT() provides the trailing newline by itself, this is nicer in the source code * BUSYBOX_CMD_HELP_OPT() provides the trailing newline by itself * made sure no line gets longer than 77 characters * delibertely renamed cmdtp->usage, so that we can get compile-time errors (e.g. in out-of-tree modules that use register_command() * the 'help' command can now always emit the usage, even without compiled long help texts * 'help -v' gives a list of commands with their short description, this is similar like the old "help" command before my patchset * 'help -a' gives out help of all commands Signed-off-by: Holger Schurig Signed-off-by: Sascha Hauer --- commands/loadxy.c | 53 ++++++++++++++++++++++++++++------------------------- 1 file changed, 28 insertions(+), 25 deletions(-) (limited to 'commands/loadxy.c') diff --git a/commands/loadxy.c b/commands/loadxy.c index daf35ab533..3044f37112 100644 --- a/commands/loadxy.c +++ b/commands/loadxy.c @@ -140,6 +140,22 @@ static int do_loady(int argc, char *argv[]) return rcode; } +BAREBOX_CMD_HELP_START(loady) +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT("-g", "use Y-Modem/G (use on lossless tty such as USB)") +BAREBOX_CMD_HELP_OPT("-b BAUD", "baudrate for download (default: console baudrate") +BAREBOX_CMD_HELP_OPT("-t NAME", "console name to use (default: current)") +BAREBOX_CMD_HELP_END + +BAREBOX_CMD_START(loady) + .cmd = do_loady, + BAREBOX_CMD_DESC("load binary file over serial line (Y-Modem)") + BAREBOX_CMD_OPTS("[-gtb]") + BAREBOX_CMD_GROUP(CMD_GRP_BOOT) + BAREBOX_CMD_HELP(cmd_loady_help) +BAREBOX_CMD_END + + /** * @brief provide the loadx(X-Modem) support * @@ -184,7 +200,7 @@ static int do_loadx(int argc, char *argv[]) else cdev = console_get_first_active(); if (!cdev) { - printf("%s:No console device %s with STDIN and STDOUT\n", + printf("%s:No console device %s with STDIN and STDOUT", argv[0], cname ? cname : "default"); return -ENODEV; } @@ -224,32 +240,19 @@ static int do_loadx(int argc, char *argv[]) return rcode; } -static const __maybe_unused char cmd_loadx_help[] = - "[OPTIONS]\n" - " -f file - where to download to - defaults to " DEF_FILE "\n" - " -o offset - what offset to download - defaults to 0\n" - " -t name - console device name to use - defaults to current console\n" - " -b baud - baudrate at which to download - defaults to console baudrate\n" - " -c - Create file if it is not present - default disabled"; +BAREBOX_CMD_HELP_START(loadx) +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT("-f FILE", "download to FILE (default " DEF_FILE ")") +BAREBOX_CMD_HELP_OPT("-o OFFS", "destination file OFFSet (default 0)") +BAREBOX_CMD_HELP_OPT("-b BAUD", "baudrate for download (default: console baudrate") +BAREBOX_CMD_HELP_OPT("-t NAME", "console name to use (default: current)") +BAREBOX_CMD_HELP_OPT("-c", "create file if not present") +BAREBOX_CMD_HELP_END -#ifdef CONFIG_CMD_LOADY BAREBOX_CMD_START(loadx) .cmd = do_loadx, - .usage = "Load binary file over serial line (X-Modem)", - BAREBOX_CMD_GROUP(CMD_GRP_BOOT) -BAREBOX_CMD_HELP(cmd_loadx_help) -BAREBOX_CMD_END - -static const __maybe_unused char cmd_loady_help[] = - "[OPTIONS]\n" - " -g - use Y-Modem/G (only for lossless tty as USB)\n" - " -t name - console device name to use - defaults to current console\n" - " -b baud - baudrate at which to download - defaults to console baudrate\n"; - -BAREBOX_CMD_START(loady) - .cmd = do_loady, - .usage = "Load binary file over serial line (Y-Modem or Y-Modem/G)", + BAREBOX_CMD_DESC("load binary file over serial line (X-Modem)") + BAREBOX_CMD_OPTS("[-fptbc]") BAREBOX_CMD_GROUP(CMD_GRP_BOOT) -BAREBOX_CMD_HELP(cmd_loady_help) + BAREBOX_CMD_HELP(cmd_loadx_help) BAREBOX_CMD_END -#endif -- cgit v1.2.3