9
0
Fork 0
barebox/arch/arm
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 commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
configs drop CONFIG_PARTITION_NEED_MTD 2014-05-13 09:19:46 +02:00
cpu commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
dts ARM: dts: Add generated files to clean rule 2014-05-09 09:11:49 +02:00
include/asm ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
lib commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
mach-at91 commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
mach-bcm2835 video: add a BCM2835 framebuffer driver 2013-11-06 09:59:05 +01:00
mach-clps711x ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
mach-davinci ARM: virt2real: add documentation 2014-03-19 21:42:55 +01:00
mach-ep93xx Merge branch 'for-next/boardinfo' 2013-09-05 10:39:22 +02:00
mach-highbank Merge branch 'for-next/boardinfo' 2013-09-05 10:39:22 +02:00
mach-imx ARM: imx: move malloc area to upper memory bank by default 2014-05-05 15:09:09 +02:00
mach-mvebu ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
mach-mxs commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
mach-netx commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
mach-nomadik ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
mach-omap commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
mach-pxa reset_source: rename set_reset_source to reset_source_set 2014-01-29 12:12:17 +01:00
mach-rockchip ARM: Rockchip: switch to multiimage support 2014-04-29 08:40:40 +02:00
mach-samsung reset_source: rename set_reset_source to reset_source_set 2014-01-29 12:12:17 +01:00
mach-socfpga x86: ns16550: Rework driver to allow for x86 I/O space 2014-04-09 19:31:42 +02:00
mach-tegra ARM: tegra30: ramp vdd_core to 1,2V 2014-05-08 09:35:50 +02:00
mach-versatile clk: remove unused __clk_[get|put] 2013-04-03 17:22:11 +02:00
mach-vexpress vexpress: mmc support 2013-10-22 16:49:48 +02:00
mach-zynq clk: gate: add flags argument to clock gate constructor 2014-04-29 08:15:24 +02:00
pbl scripts: fix_size: check magic 2014-01-31 18:51:49 +01:00
tools arm: Update mach-types 2013-09-27 10:56:37 +02:00
Kconfig Merge branch 'for-next/rockchip' 2014-05-05 13:33:09 +02:00
Makefile ARM: add basic support for Rockchip SoCs 2014-04-29 08:12:33 +02:00
mach-arm.dox ARM: davinci: add documentation 2014-03-18 17:28:11 +01:00