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/clk.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/clk.c')
-rw-r--r-- | commands/clk.c | 40 |
1 files changed, 13 insertions, 27 deletions
diff --git a/commands/clk.c b/commands/clk.c index 6718ae8eaa..4e7ca60a29 100644 --- a/commands/clk.c +++ b/commands/clk.c @@ -18,16 +18,11 @@ static int do_clk_enable(int argc, char *argv[]) return clk_enable(clk); } -BAREBOX_CMD_HELP_START(clk_enable) -BAREBOX_CMD_HELP_USAGE("clk_enable <clk>\n") -BAREBOX_CMD_HELP_SHORT("enable <clk>\n") -BAREBOX_CMD_HELP_END - BAREBOX_CMD_START(clk_enable) .cmd = do_clk_enable, - .usage = "enable a clock", + BAREBOX_CMD_DESC("enable a clock") + BAREBOX_CMD_OPTS("CLK") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) - BAREBOX_CMD_HELP(cmd_clk_enable_help) BAREBOX_CMD_END static int do_clk_disable(int argc, char *argv[]) @@ -46,16 +41,11 @@ static int do_clk_disable(int argc, char *argv[]) return 0; } -BAREBOX_CMD_HELP_START(clk_disable) -BAREBOX_CMD_HELP_USAGE("clk_disable <clk>\n") -BAREBOX_CMD_HELP_SHORT("disable <clk>\n") -BAREBOX_CMD_HELP_END - BAREBOX_CMD_START(clk_disable) .cmd = do_clk_disable, - .usage = "disable a clock", + BAREBOX_CMD_DESC("disable a clock") + BAREBOX_CMD_OPTS("CLK") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) - BAREBOX_CMD_HELP(cmd_clk_disable_help) BAREBOX_CMD_END static int do_clk_set_rate(int argc, char *argv[]) @@ -76,13 +66,13 @@ static int do_clk_set_rate(int argc, char *argv[]) } BAREBOX_CMD_HELP_START(clk_set_rate) -BAREBOX_CMD_HELP_USAGE("clk_set_rate <clk> <rate_hz>\n") -BAREBOX_CMD_HELP_SHORT("Set clock <clk> to <rate>\n") +BAREBOX_CMD_HELP_TEXT("Set clock CLK to RATE") BAREBOX_CMD_HELP_END BAREBOX_CMD_START(clk_set_rate) .cmd = do_clk_set_rate, - .usage = "set a clocks rate", + BAREBOX_CMD_DESC("set a clocks rate") + BAREBOX_CMD_OPTS("CLK HZ") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) BAREBOX_CMD_HELP(cmd_clk_set_rate_help) BAREBOX_CMD_END @@ -108,13 +98,14 @@ static int do_clk_dump(int argc, char *argv[]) } BAREBOX_CMD_HELP_START(clk_dump) -BAREBOX_CMD_HELP_USAGE("clk_dump [-v]\n") -BAREBOX_CMD_HELP_OPT ("-v", "verbose\n") +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT ("-v", "verbose") BAREBOX_CMD_HELP_END BAREBOX_CMD_START(clk_dump) .cmd = do_clk_dump, - .usage = "show information about registered clocks", + BAREBOX_CMD_DESC("show information about registered clocks") + BAREBOX_CMD_OPTS("[-v]") BAREBOX_CMD_GROUP(CMD_GRP_INFO) BAREBOX_CMD_HELP(cmd_clk_dump_help) BAREBOX_CMD_END @@ -136,14 +127,9 @@ static int do_clk_set_parent(int argc, char *argv[]) return clk_set_parent(clk, parent); } -BAREBOX_CMD_HELP_START(clk_set_parent) -BAREBOX_CMD_HELP_USAGE("clk_set_parent <clk> <parent>\n") -BAREBOX_CMD_HELP_SHORT("Set parent of <clk> to <parent>\n") -BAREBOX_CMD_HELP_END - BAREBOX_CMD_START(clk_set_parent) .cmd = do_clk_set_parent, - .usage = "set a parent of a clock", + BAREBOX_CMD_DESC("set parent of a clock") + BAREBOX_CMD_OPTS("CLK PARENT") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) - BAREBOX_CMD_HELP(cmd_clk_set_parent_help) BAREBOX_CMD_END |