9
0
Fork 0
barebox/drivers
Holger Schurig f1f532084a 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>
2014-05-14 10:03:43 +02:00
..
amba treewide: Use dev_add_param_int_ro where possible 2013-04-11 11:48:35 +02:00
ata Merge branch 'for-next/misc' 2014-05-05 13:32:37 +02:00
base common: Allow for I/O mapped I/O 2014-04-08 08:17:55 +02:00
bus bus: mvebu: add mbus driver 2014-02-10 09:08:51 +01:00
clk Merge branch 'for-next/tegra' 2014-05-05 13:34:21 +02:00
clocksource clocksource: add dummy software-only clocksource 2014-03-19 21:43:43 +01:00
dma mtd: nand: mxs-nand: Add i.MX6 support 2013-07-23 16:25:14 +02:00
eeprom remove redundant NULL check on free 2014-02-10 08:49:55 +01:00
gpio commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
i2c i2c: implement of_find_i2c_adapter_by_node 2014-03-28 08:45:11 +01:00
input imx_keypad: Fix error handling 2014-04-23 14:01:45 +02:00
led led: Add default-on trigger 2014-03-03 08:06:04 +01:00
mci Merge branch 'for-next/tegra' 2014-05-05 13:34:21 +02:00
mfd Merge branch 'for-next/rockchip' 2014-05-05 13:33:09 +02:00
misc Merge branch 'for-next/ioresource' 2014-05-05 11:05:51 +02:00
mtd commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
net Merge branch 'for-next/rockchip' 2014-05-05 13:33:09 +02:00
of Merge branch 'for-next/of' 2014-05-05 13:32:37 +02:00
pinctrl Merge branch 'for-next/tegra' 2014-05-05 13:34:21 +02:00
pwm PWM: Implement devicetree support 2014-02-28 15:05:46 +01:00
regulator Add initial regulator support 2014-04-29 08:01:32 +02:00
serial Merge branch 'for-next/ioresource' 2014-05-05 11:05:51 +02:00
spi Merge branch 'for-next/misc' 2014-05-05 13:32:37 +02:00
usb commands: group 'help' output 2014-05-14 07:59:55 +02:00
video video: i.MX IPUv3: Print error as string 2014-05-08 09:55:06 +02:00
w1 w1: Fix compiler warning 2013-03-06 09:04:26 +01:00
watchdog reset_source: rename set_reset_source to reset_source_set 2014-01-29 12:12:17 +01:00
Kconfig Add initial regulator support 2014-04-29 08:01:32 +02:00
Makefile Add initial regulator support 2014-04-29 08:01:32 +02:00