|author||Holger Schurig <firstname.lastname@example.org>||2014-05-13 10:28:42 +0200|
|committer||Sascha Hauer <email@example.com>||2014-05-14 10:03:43 +0200|
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 <firstname.lastname@example.org> Signed-off-by: Sascha Hauer <email@example.com>
Diffstat (limited to 'commands/memtest.c')
1 files changed, 8 insertions, 6 deletions
diff --git a/commands/memtest.c b/commands/memtest.c
index 8308c6c..c1ffc64 100644
@@ -230,15 +230,17 @@ out:
-static const __maybe_unused char cmd_memtest_help =
-"Usage: memtest [OPTION]...\n"
-"memtest related commands\n"
-" -i <iterations> iterations [default=1, endless=0].\n"
-" -b perform only a test on buslines.";
+BAREBOX_CMD_HELP_OPT("-i ITERATIONS", "perform number of iterations (default 1, 0 is endless)")
+BAREBOX_CMD_HELP_OPT("-b", "perform only a test on bus lines")
.cmd = do_memtest,
- .usage = "Memory Test",
+ BAREBOX_CMD_DESC("extensive memory test")