9
0
Fork 0
barebox/arch/arm/boards
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
..
a9m2410 mtd: nand: create bb devices automatically 2014-04-28 11:45:09 +02:00
a9m2440 mtd: nand: create bb devices automatically 2014-04-28 11:45:09 +02:00
animeo_ip ARM: animeo_ip: Use __iomem specifier for memory pointer 2014-01-29 10:18:42 +01:00
archosg9 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
at91rm9200ek ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
at91sam9m10g45ek input: Add BB_ prefix to KEY_ defines 2014-02-17 08:23:37 +01:00
at91sam9m10ihd input: Add BB_ prefix to KEY_ defines 2014-02-17 08:23:37 +01:00
at91sam9n12ek ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
at91sam9x5ek ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
at91sam9260ek ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
at91sam9261ek input: Add BB_ prefix to KEY_ defines 2014-02-17 08:23:37 +01:00
at91sam9263ek ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
avnet-zedboard ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
beagle ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
beaglebone ARM: beaglebone: remove extra FDT memcpy 2014-05-05 15:09:09 +02:00
boundarydevices-nitrogen6x ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
ccxmx51 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
chumby_falconwing ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
clep7212 ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
crystalfontz-cfa10036 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
datamodul-edm-qmx6 ARM: eDM-QMX6: remove extra FDT memcpy 2014-05-05 15:09:09 +02:00
delphi-poc20/env/boot Add DMO RealQ7 board support 2013-03-11 09:19:55 +01:00
dfi-fs700-m60 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
dss11 ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
ebv-socrates ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
edb93xx ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
efika-mx-smartbook ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
embest-riotboard ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
eukrea_cpuimx25 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
eukrea_cpuimx27 Merge branch 'for-next/ioresource' 2014-05-05 11:05:51 +02:00
eukrea_cpuimx35 commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
eukrea_cpuimx51 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
freescale-mx6-arm2 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
freescale-mx6-sabrelite ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
freescale-mx6-sabresd ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
freescale-mx21-ads video: Add display timing from devicetree helper 2014-03-29 07:57:47 +01:00
freescale-mx23-evk ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
freescale-mx25-3ds mtd: nand: create bb devices automatically 2014-04-28 11:45:09 +02:00
freescale-mx27-ads ARM: rename boards to more consistent naming 2014-02-03 15:09:14 +01:00
freescale-mx28-evk ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
freescale-mx35-3ds video: Add display timing from devicetree helper 2014-03-29 07:57:47 +01:00
freescale-mx51-babbage ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
freescale-mx53-qsb ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
freescale-mx53-smd ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
freescale-mx53-vmx53 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
friendlyarm-mini2440 video: Add display timing from devicetree helper 2014-03-29 07:57:47 +01:00
friendlyarm-mini6410 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
friendlyarm-tiny210 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
friendlyarm-tiny6410 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
gk802 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
globalscale-guruplug ARM: Marvell boards: remove empty config.h files 2013-06-24 13:01:51 +02:00
globalscale-mirabox Merge branch 'for-next/config-h' 2013-07-01 09:32:05 +02:00
guf-cupid commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
guf-neso ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
guf-santaro ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
guf-vincell ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
highbank ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
imx233-olinuxino ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
karo-tx25 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
karo-tx28 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
karo-tx51 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
karo-tx53 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
marvell-armada-xp-gp ARM: Marvell boards: remove empty config.h files 2013-06-24 13:01:51 +02:00
mioa701 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
mmccpu mtd: nand: create bb devices automatically 2014-04-28 11:45:09 +02:00
mx31moboard ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
netx ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
nhk8815 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
nvidia-beaver ARM: tegra30: ramp vdd_core to 1,2V 2014-05-08 09:35:50 +02:00
omap3evm ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
omap343xdsp ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
panda ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
phytec-phycard-imx6 ARM: phycard-imx6: fixup for barebox_arm_entry signature change 2014-05-07 09:45:18 +02:00
phytec-phycard-imx27 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
phytec-phycard-omap3 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
phytec-phycard-omap4 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
phytec-phycore-am335x ARM: phycore-am33xx: remove extra FDT memcpy 2014-05-05 15:09:09 +02:00
phytec-phycore-imx27 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
phytec-phycore-imx31 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
phytec-phycore-imx35 commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
phytec-phycore-omap4460 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
phytec-phycore-pxa270 ARM: rename boards to more consistent naming 2014-02-03 15:09:14 +01:00
phytec-phyflex-imx6 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
plathome-openblocks-ax3 ARM: Marvell boards: remove empty config.h files 2013-06-24 13:01:51 +02:00
pm9g45 ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
pm9261 ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
pm9263 mtd: nand: create bb devices automatically 2014-04-28 11:45:09 +02:00
qil-a926x ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
radxa-rock ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
raspberry-pi ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
sama5d3xek ARM: sama5d3xek: convert to devfs_create_partitions 2014-02-28 11:19:10 +01:00
scb9328 ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
solidrun-cubox ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
solidrun-hummingboard ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
telit-evk-pro3 ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
terasic-sockit ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
tny-a926x ARM: remove armlinux_set_bootparams() calls from boards 2014-01-06 14:25:05 +01:00
toradex-colibri-t20 tegra: disable more lowlevel unsafe switch optimizations 2014-04-23 11:39:13 +02:00
toshiba-ac100 tegra: disable more lowlevel unsafe switch optimizations 2014-04-23 11:39:13 +02:00
tqma6x ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
tqma53 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
udoo ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
usb-a926x input: Add BB_ prefix to KEY_ defines 2014-02-17 08:23:37 +01:00
usi-topkick arm: mvebu: add board USI Topkick 2013-07-22 09:21:14 +02:00
variscite-mx6 ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
versatile ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
vexpress ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
virt2real ARM: change signature of barebox_arm_entry 2014-05-05 15:09:09 +02:00
Makefile Merge branch 'for-next/tegra' 2014-05-05 13:34:21 +02:00