9
0
Fork 0
barebox/arch/arm/mach-at91
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
..
include/mach ARM: at91: add sama5d36 SoC support 2014-03-31 08:33:10 +02:00
Kconfig Cleanup Kconfig files 2013-11-11 08:52:05 +01:00
Makefile at91: add irq fixup 2013-09-18 09:16:45 +02:00
at91rm9200.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91rm9200_devices.c ARM: AT91: move iomux definitions to iomux.h 2013-08-16 15:58:33 +02:00
at91rm9200_lowlevel_init.c ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
at91rm9200_time.c Treewide: remove address of the Free Software Foundation 2012-09-17 10:57:41 +02:00
at91sam9_reset.S at91sam9: drop AT91_BASE_SYS for sdram controller 2013-02-05 10:26:49 +01:00
at91sam9g45.c ARM: at91: move main clock define to C 2013-07-09 18:57:35 +02:00
at91sam9g45_devices.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9g45_lowlevel_init.c ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
at91sam9g45_reset.S at91: fix reset 2011-12-14 12:14:44 +01:00
at91sam9n12.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9n12_devices.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9n12_lowlevel_init.c ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
at91sam9x5.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9x5_devices.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9x5_lowlevel_init.c ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
at91sam926x_lowlevel_init.c at91sam9: drop AT91_BASE_SYS for sdram controller 2013-02-05 10:26:49 +01:00
at91sam926x_time.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9260.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9260_devices.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9260_lowlevel_init.c ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
at91sam9261.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9261_devices.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9261_lowlevel_init.c ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
at91sam9263.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9263_devices.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
at91sam9263_lowlevel_init.c ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
boot_test_cmd.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
bootstrap.c at91: bootstrap: add menu support 2013-01-31 19:16:33 +01:00
clock.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
clock.h at91: add sama5d3 support 2013-01-30 08:24:39 +01:00
generic.h at91: add irq fixup 2013-09-18 09:16:45 +02:00
gpio.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
gpio.h at91: gpio: split accessor so we can use them for early init 2013-02-05 10:26:49 +01:00
irq_fixup.c ARM: at91: irq_fixup: Use __iomem specifier for memory pointer 2014-01-29 10:18:42 +01:00
sam9_smc.c ARM: at91 smc: Fix possible uninitialized variable 2013-04-30 09:35:55 +02:00
sama5d3.c ARM: at91: add sama5d36 SoC support 2014-03-31 08:33:10 +02:00
sama5d3_devices.c ARM: remove asm/hardware.h 2013-11-08 15:44:13 +01:00
sama5d3_lowlevel_init.c ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
setup.c ARM: at91: add missing break 2014-04-23 09:04:29 +02:00
soc.h at91: add sama5d3 support 2013-01-30 08:24:39 +01:00