summaryrefslogtreecommitdiffstats
path: root/commands/let.c
diff options
context:
space:
mode:
authorHolger Schurig <holgerschurig@gmail.com>2014-05-13 10:28:42 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2014-05-14 10:03:43 +0200
commitf1f532084a6e9ee8225f047353999b459455df7e (patch)
treef2b8b1f25c5c630209c6970e3a7ce57a3d55d367 /commands/let.c
parentab23d0bb3f66cfb7a97a8aa6b8007687ed7a6925 (diff)
downloadbarebox-f1f532084a6e9ee8225f047353999b459455df7e.tar.gz
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/let.c')
-rw-r--r--commands/let.c43
1 files changed, 21 insertions, 22 deletions
diff --git a/commands/let.c b/commands/let.c
index 68c98e3..3c84d27 100644
--- a/commands/let.c
+++ b/commands/let.c
@@ -63,32 +63,31 @@ static int do_let(int argc, char *argv[])
}
BAREBOX_CMD_HELP_START(let)
-BAREBOX_CMD_HELP_USAGE("let expr [expr ...]\n")
-BAREBOX_CMD_HELP_SHORT("evaluate arithmetic expressions\n")
-BAREBOX_CMD_HELP_TEXT ("supported operations are in order of decreasing precedence:\n")
-BAREBOX_CMD_HELP_TEXT (" X++, X--\n")
-BAREBOX_CMD_HELP_TEXT (" ++X, --X\n")
-BAREBOX_CMD_HELP_TEXT (" +X, -X\n")
-BAREBOX_CMD_HELP_TEXT (" !X, ~X\n")
-BAREBOX_CMD_HELP_TEXT (" X**Y\n")
-BAREBOX_CMD_HELP_TEXT (" X*Y, X/Y, X%Y\n")
-BAREBOX_CMD_HELP_TEXT (" X+Y, X-Y\n")
-BAREBOX_CMD_HELP_TEXT (" X<<Y, X>>Y\n")
-BAREBOX_CMD_HELP_TEXT (" X<Y, X<=Y, X>=Y, X>Y\n")
-BAREBOX_CMD_HELP_TEXT (" X==Y, X!=Y\n")
-BAREBOX_CMD_HELP_TEXT (" X&Y\n")
-BAREBOX_CMD_HELP_TEXT (" X^Y\n")
-BAREBOX_CMD_HELP_TEXT (" X|Y\n")
-BAREBOX_CMD_HELP_TEXT (" X&&Y\n")
-BAREBOX_CMD_HELP_TEXT (" X||Y\n")
-BAREBOX_CMD_HELP_TEXT (" X?Y:Z\n")
-BAREBOX_CMD_HELP_TEXT (" X*=Y, X/=Y, X%=Y\n")
-BAREBOX_CMD_HELP_TEXT (" X=Y, X&=Y, X|=Y, X^=Y, X+=Y, X-=Y, X<<=Y, X>>=Y\n")
+BAREBOX_CMD_HELP_TEXT ("Supported operations are in order of decreasing precedence:")
+BAREBOX_CMD_HELP_TEXT (" X++, X--")
+BAREBOX_CMD_HELP_TEXT (" ++X, --X")
+BAREBOX_CMD_HELP_TEXT (" +X, -X")
+BAREBOX_CMD_HELP_TEXT (" !X, ~X")
+BAREBOX_CMD_HELP_TEXT (" X**Y")
+BAREBOX_CMD_HELP_TEXT (" X*Y, X/Y, X%Y")
+BAREBOX_CMD_HELP_TEXT (" X+Y, X-Y")
+BAREBOX_CMD_HELP_TEXT (" X<<Y, X>>Y")
+BAREBOX_CMD_HELP_TEXT (" X<Y, X<=Y, X>=Y, X>Y")
+BAREBOX_CMD_HELP_TEXT (" X==Y, X!=Y")
+BAREBOX_CMD_HELP_TEXT (" X&Y")
+BAREBOX_CMD_HELP_TEXT (" X^Y")
+BAREBOX_CMD_HELP_TEXT (" X|Y")
+BAREBOX_CMD_HELP_TEXT (" X&&Y")
+BAREBOX_CMD_HELP_TEXT (" X||Y")
+BAREBOX_CMD_HELP_TEXT (" X?Y:Z")
+BAREBOX_CMD_HELP_TEXT (" X*=Y, X/=Y, X%=Y")
+BAREBOX_CMD_HELP_TEXT (" X=Y, X&=Y, X|=Y, X^=Y, X+=Y, X-=Y, X<<=Y, X>>=Y")
BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(let)
.cmd = do_let,
- .usage = "evaluate arithmetic expressions",
+ BAREBOX_CMD_DESC("evaluate arithmetic expressions")
+ BAREBOX_CMD_OPTS("EXPR [EXPR ...]")
BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT)
BAREBOX_CMD_HELP(cmd_let_help)
BAREBOX_CMD_END