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 --- arch/arm/cpu/cpuinfo.c | 2 +- arch/arm/cpu/mmuinfo.c | 9 ++------- 2 files changed, 3 insertions(+), 8 deletions(-) (limited to 'arch/arm/cpu') diff --git a/arch/arm/cpu/cpuinfo.c b/arch/arm/cpu/cpuinfo.c index 2cee48b43d..8b22e9bb50 100644 --- a/arch/arm/cpu/cpuinfo.c +++ b/arch/arm/cpu/cpuinfo.c @@ -210,7 +210,7 @@ static int do_cpuinfo(int argc, char *argv[]) BAREBOX_CMD_START(cpuinfo) .cmd = do_cpuinfo, - .usage = "Show info about CPU", + BAREBOX_CMD_DESC("show info about CPU") BAREBOX_CMD_GROUP(CMD_GRP_INFO) BAREBOX_CMD_COMPLETE(empty_complete) BAREBOX_CMD_END diff --git a/arch/arm/cpu/mmuinfo.c b/arch/arm/cpu/mmuinfo.c index 032798e9f5..79f539f888 100644 --- a/arch/arm/cpu/mmuinfo.c +++ b/arch/arm/cpu/mmuinfo.c @@ -99,14 +99,9 @@ static int do_mmuinfo(int argc, char *argv[]) return 0; } -BAREBOX_CMD_HELP_START(mmuinfo) -BAREBOX_CMD_HELP_USAGE("mmuinfo
\n") -BAREBOX_CMD_HELP_SHORT("Show MMU/cache information for an address.\n") -BAREBOX_CMD_HELP_END - BAREBOX_CMD_START(mmuinfo) .cmd = do_mmuinfo, - .usage = "mmuinfo
", + BAREBOX_CMD_DESC("show MMU/cache information of an address") + BAREBOX_CMD_OPTS("ADDRESS") BAREBOX_CMD_GROUP(CMD_GRP_INFO) - BAREBOX_CMD_HELP(cmd_mmuinfo_help) BAREBOX_CMD_END -- cgit v1.2.3