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/bootm.c | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) (limited to 'commands/bootm.c') diff --git a/commands/bootm.c b/commands/bootm.c index af2cb6935b..5801f4422c 100644 --- a/commands/bootm.c +++ b/commands/bootm.c @@ -141,27 +141,38 @@ err_out: } BAREBOX_CMD_HELP_START(bootm) -BAREBOX_CMD_HELP_USAGE("bootm [OPTIONS] image\n") -BAREBOX_CMD_HELP_SHORT("Boot an application image.\n") -BAREBOX_CMD_HELP_OPT ("-c", "crc check uImage data\n") -BAREBOX_CMD_HELP_OPT ("-d", "dryrun. Check data, but do not run\n") +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT ("-c", "crc check uImage data") +BAREBOX_CMD_HELP_OPT ("-d", "dryrun. Check data, but do not run") #ifdef CONFIG_CMD_BOOTM_INITRD -BAREBOX_CMD_HELP_OPT ("-r ","specify an initrd image\n") -BAREBOX_CMD_HELP_OPT ("-L ","specify initrd load address\n") +BAREBOX_CMD_HELP_OPT ("-r INITRD","specify an initrd image") +BAREBOX_CMD_HELP_OPT ("-L ADDR","specify initrd load address") #endif -BAREBOX_CMD_HELP_OPT ("-a ","specify os load address\n") -BAREBOX_CMD_HELP_OPT ("-e ","entry point to the image relative to start (0)\n") +BAREBOX_CMD_HELP_OPT ("-a ADDR","specify os load address") +BAREBOX_CMD_HELP_OPT ("-e OFFS","entry point to the image relative to start (0)") #ifdef CONFIG_OFTREE -BAREBOX_CMD_HELP_OPT ("-o ","specify oftree\n") +BAREBOX_CMD_HELP_OPT ("-o DTS","specify device tree") #endif #ifdef CONFIG_CMD_BOOTM_VERBOSE -BAREBOX_CMD_HELP_OPT ("-v","verbose\n") +BAREBOX_CMD_HELP_OPT ("-v\t","verbose") #endif BAREBOX_CMD_HELP_END BAREBOX_CMD_START(bootm) .cmd = do_bootm, - .usage = "boot an application image", + BAREBOX_CMD_DESC("boot an application image") + BAREBOX_CMD_OPTS("[-cd" +#ifdef CONFIG_CMD_BOOTM_INITRD + "rL" +#endif + "ae" +#ifdef CONFIG_OFTREE + "o" +#endif +#ifdef CONFIG_CMD_BOOTM_VERBOSE + "v" +#endif + "] IMAGE") BAREBOX_CMD_GROUP(CMD_GRP_BOOT) BAREBOX_CMD_HELP(cmd_bootm_help) BAREBOX_CMD_END -- cgit v1.2.3