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/i2c.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/i2c.c')
-rw-r--r-- | commands/i2c.c | 48 |
1 files changed, 27 insertions, 21 deletions
diff --git a/commands/i2c.c b/commands/i2c.c index 137cd8540f..2811f6abeb 100644 --- a/commands/i2c.c +++ b/commands/i2c.c @@ -56,13 +56,14 @@ static int do_i2c_probe(int argc, char *argv[]) return 0; } -static const __maybe_unused char cmd_i2c_probe_help[] = -"Usage: i2c_probe bus 0xstartaddr 0xstopaddr\n" -"probe a range of i2c addresses.\n"; +BAREBOX_CMD_HELP_START(i2c_probe) +BAREBOX_CMD_HELP_TEXT("Probe the i2c bus BUS, address range from START to END for devices.") +BAREBOX_CMD_HELP_END BAREBOX_CMD_START(i2c_probe) .cmd = do_i2c_probe, - .usage = "probe for an i2c device", + BAREBOX_CMD_DESC("probe for an i2c device") + BAREBOX_CMD_OPTS("BUS START END") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) BAREBOX_CMD_HELP(cmd_i2c_probe_help) BAREBOX_CMD_END @@ -130,17 +131,19 @@ out: return ret; } -static const __maybe_unused char cmd_i2c_write_help[] = -"Usage: i2c_write [OPTION] ... hexdatas\n" -"write to i2c device.\n" -" -a 0x<addr> i2c device address\n" -" -b <bus_num> i2c bus number (default = 0)\n" -" -r 0x<reg> start register\n" -" -w use 16bit-wide address access\n"; +BAREBOX_CMD_HELP_START(i2c_write) +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT ("-b BUS\t", "i2c bus number (default 0)") +BAREBOX_CMD_HELP_OPT ("-a ADDR\t", "i2c device address") +BAREBOX_CMD_HELP_OPT ("-r START", "start register") +BAREBOX_CMD_HELP_OPT ("-w\t", "use word (16 bit) wide access") +BAREBOX_CMD_HELP_OPT ("-v\t", "verbose") +BAREBOX_CMD_HELP_END BAREBOX_CMD_START(i2c_write) .cmd = do_i2c_write, - .usage = "write to an i2c device", + BAREBOX_CMD_DESC("write to an i2c device") + BAREBOX_CMD_OPTS("[-barwv] DATA...") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) BAREBOX_CMD_HELP(cmd_i2c_write_help) BAREBOX_CMD_END @@ -204,18 +207,21 @@ static int do_i2c_read(int argc, char *argv[]) return ret; } -static const __maybe_unused char cmd_i2c_read_help[] = -"Usage: i2c_read [OPTION]\n" -"read i2c device.\n" -" -a 0x<addr> i2c device address\n" -" -b <bus_num> i2c bus number (default = 0)\n" -" -r 0x<reg> start register\n" -" -w use 16bit-wide address access\n" -" -c <count> byte count\n"; +BAREBOX_CMD_HELP_START(i2c_read) +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT("-b BUS\t", "i2c bus number (default 0)") +BAREBOX_CMD_HELP_OPT("-a ADDR\t", "i2c device address") +BAREBOX_CMD_HELP_OPT("-r START", "start register") +BAREBOX_CMD_HELP_OPT("-w\t", "use word (16 bit) wide access") +BAREBOX_CMD_HELP_OPT("-c COUNT", "byte count") +BAREBOX_CMD_HELP_OPT("-v\t", "verbose") +BAREBOX_CMD_HELP_END + BAREBOX_CMD_START(i2c_read) .cmd = do_i2c_read, - .usage = "read from an i2c device", + BAREBOX_CMD_DESC("read from an i2c device") + BAREBOX_CMD_OPTS("[-bacrwv] DATA...") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) BAREBOX_CMD_HELP(cmd_i2c_read_help) BAREBOX_CMD_END |