9
0
Fork 0
barebox/arch/mips/lib
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
..
.gitignore MIPS: add common MIPS stuff 2011-08-05 18:20:17 +02:00
Makefile mips: initialize malloc pool before start_barebox() 2013-03-14 08:41:15 +01:00
ashldi3.c MIPS: import libgcc-related files from linux-2.6.39 2011-08-05 18:20:17 +02:00
ashrdi3.c MIPS: import libgcc-related files from linux-2.6.39 2011-08-05 18:20:17 +02:00
asm-offsets.c MIPS: add asm-offsets.h generation 2013-12-04 17:01:11 +01:00
barebox.lds.S MIPS: lib: add BAREBOX_CLK_TABLE to linker script 2014-03-28 10:28:15 +01:00
bootm.c MIPS: bootm: add "MIPS barebox" handler 2012-05-11 09:05:11 +02:00
c-r4k.c MIPS: import CPU and cache detection code from Linux 3.4 2012-05-23 18:47:53 +02:00
cpu-probe.c MIPS: add Loongson-1B processor constants and CPU probe 2014-01-21 07:59:37 +01:00
cpuinfo.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
csrc-r4k.c MIPS: csrc-r4k: use CLOCKSOURCE_MASK() macro 2014-01-30 10:43:56 +01:00
genex.S MIPS: import exception registers saving from linux kernel 2013-12-04 17:01:11 +01:00
libgcc.h mips: Fix compiler warnings 2012-04-05 08:50:01 +02:00
lshrdi3.c MIPS: import libgcc-related files from linux-2.6.39 2011-08-05 18:20:17 +02:00
traps.c MIPS: import exception registers saving from linux kernel 2013-12-04 17:01:11 +01:00