diff options
author | Holger Schurig <holgerschurig@gmail.com> | 2014-05-13 10:28:42 +0200 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2014-05-14 10:03:43 +0200 |
commit | f1f532084a6e9ee8225f047353999b459455df7e (patch) | |
tree | f2b8b1f25c5c630209c6970e3a7ce57a3d55d367 /commands/uimage.c | |
parent | ab23d0bb3f66cfb7a97a8aa6b8007687ed7a6925 (diff) | |
download | barebox-f1f532084a6e9ee8225f047353999b459455df7e.tar.gz barebox-f1f532084a6e9ee8225f047353999b459455df7e.tar.xz |
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 <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'commands/uimage.c')
-rw-r--r-- | commands/uimage.c | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/commands/uimage.c b/commands/uimage.c index a4bc2cc638..33523d7e5c 100644 --- a/commands/uimage.c +++ b/commands/uimage.c @@ -60,7 +60,7 @@ static int do_uimage(int argc, char *argv[]) } if (verify) { - printf("verifying data crc... "); + printf("verifying data CRC... "); ret = uimage_verify(handle); if (ret) goto err; @@ -91,16 +91,17 @@ err: } BAREBOX_CMD_HELP_START(uimage) -BAREBOX_CMD_HELP_USAGE("uimage [OPTIONS] <file>\n") -BAREBOX_CMD_HELP_OPT ("-i", "show information about image\n") -BAREBOX_CMD_HELP_OPT ("-v", "verify image\n") -BAREBOX_CMD_HELP_OPT ("-e <outfile>", "extract image to <outfile>\n") -BAREBOX_CMD_HELP_OPT ("-n <no>", "use image number <no> in multifile images\n") +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT ("-i\t", "show information about image") +BAREBOX_CMD_HELP_OPT ("-v\t", "verify image") +BAREBOX_CMD_HELP_OPT ("-e OUTFILE", "extract image to OUTFILE") +BAREBOX_CMD_HELP_OPT ("-n NO\t", "use image number NO in multifile image") BAREBOX_CMD_HELP_END BAREBOX_CMD_START(uimage) .cmd = do_uimage, - .usage = "extract/verify uImage", + BAREBOX_CMD_DESC("extract/verify uImage") + BAREBOX_CMD_OPTS("[-vien] FILE") BAREBOX_CMD_GROUP(CMD_GRP_BOOT) BAREBOX_CMD_HELP(cmd_uimage_help) BAREBOX_CMD_END |