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/readf.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'commands/readf.c') diff --git a/commands/readf.c b/commands/readf.c index be88dfae32..c8cc574f35 100644 --- a/commands/readf.c +++ b/commands/readf.c @@ -50,15 +50,15 @@ out: } BAREBOX_CMD_HELP_START(readf) -BAREBOX_CMD_HELP_USAGE("readf \n") -BAREBOX_CMD_HELP_SHORT("Read a single line of a file into a shell variable. Leading and trailing whitespaces\n") -BAREBOX_CMD_HELP_SHORT("are removed, nonvisible characters are stripped. Input is limited to 1024\n") -BAREBOX_CMD_HELP_SHORT("characters.\n") +BAREBOX_CMD_HELP_TEXT("Read a single line from FILE into a VARiable. Leading and trailing") +BAREBOX_CMD_HELP_TEXT("whitespaces are removed, nonvisible characters are stripped. Input is") +BAREBOX_CMD_HELP_TEXT("limited to 1024 characters.") BAREBOX_CMD_HELP_END BAREBOX_CMD_START(readf) .cmd = do_readf, - .usage = "read file into variable", + BAREBOX_CMD_DESC("read file into variable") + BAREBOX_CMD_OPTS("FILE VAR") BAREBOX_CMD_GROUP(CMD_GRP_SCRIPT) BAREBOX_CMD_HELP(cmd_readf_help) BAREBOX_CMD_END -- cgit v1.2.3