9
0
Fork 0
barebox/arch/mips
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
..
boards Merge branch 'for-next/mips' 2014-05-05 11:06:17 +02:00
boot rework debug_ll 2013-09-05 10:15:48 +02:00
configs MIPS: loongson-ls1b: switch to device tree 2014-04-08 08:03:45 +02:00
dts Merge branch 'for-next/mips' 2014-05-05 11:06:17 +02:00
include/asm mips: io: include generic io.h 2014-04-09 08:31:07 +02:00
lib commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
mach-ar231x x86: ns16550: Rework driver to allow for x86 I/O space 2014-04-09 19:31:42 +02:00
mach-ath79 MIPS: ath79: add tplink-mr3020 board support 2014-03-28 10:45:54 +01:00
mach-bcm47xx mips: bcm47xx: Fix compiler warning 2013-10-02 09:50:48 +02:00
mach-loongson MIPS: loongson-ls1b: add documentation 2014-01-30 10:43:56 +01:00
mach-malta MIPS: qemu-malta: add CBUS UART support 2014-04-03 07:55:16 +02:00
mach-xburst MIPS: boards: rename rzx50 -> ritmix-rzx50 2014-03-26 09:02:41 +01:00
pbl pbl: add generated file piggy.lz4 to .gitignore 2013-08-05 12:11:25 +02:00
Kconfig MIPS: ath79: add DEBUG_LL support for Atheros AR933x 2014-03-28 10:28:15 +01:00
Makefile MIPS: ath79: add tplink-mr3020 board support 2014-03-28 10:45:54 +01:00
mach-mips.dox MIPS: add initial Loongson-family documentation 2014-01-21 07:59:37 +01:00