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>
1 parent ab23d0b commit f1f532084a6e9ee8225f047353999b459455df7e
@Holger Schurig Holger Schurig authored on 13 May 2014
Sascha Hauer committed on 14 May 2014
Showing 124 changed files
View
arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.c
Too large (Show diff)
View
arch/arm/boards/guf-cupid/board.c
Too large (Show diff)
View
arch/arm/boards/phytec-phycore-imx35/pcm043.c
Too large (Show diff)
View
arch/arm/cpu/cpuinfo.c
Too large (Show diff)
View
arch/arm/cpu/mmuinfo.c
Too large (Show diff)
View
arch/arm/lib/bootu.c
Too large (Show diff)
View
arch/arm/lib/bootz.c
Too large (Show diff)
View
arch/arm/mach-at91/boot_test_cmd.c
Too large (Show diff)
View
arch/arm/mach-at91/clock.c
Too large (Show diff)
View
arch/arm/mach-at91/gpio.c
Too large (Show diff)
View
arch/arm/mach-mxs/bcb.c
Too large (Show diff)
View
arch/arm/mach-netx/generic.c
Too large (Show diff)
View
arch/arm/mach-omap/boot_order.c
Too large (Show diff)
View
arch/blackfin/boards/ipe337/cmd_alternate.c
Too large (Show diff)
View
arch/mips/lib/cpuinfo.c
Too large (Show diff)
View
arch/openrisc/lib/cpuinfo.c
Too large (Show diff)
View
commands/2048.c
Too large (Show diff)
View
commands/automount.c
Too large (Show diff)
View
commands/barebox-update.c
Too large (Show diff)
View
commands/basename.c
Too large (Show diff)
View
commands/boot.c
Too large (Show diff)
View
commands/bootm.c
Too large (Show diff)
View
commands/cat.c
Too large (Show diff)
View
commands/cd.c
Too large (Show diff)
View
commands/clear.c
Too large (Show diff)
View
commands/clk.c
Too large (Show diff)
View
commands/cp.c
Too large (Show diff)
View
commands/crc.c
Too large (Show diff)
View
commands/detect.c
Too large (Show diff)
View
commands/devinfo.c
Too large (Show diff)
View
commands/dfu.c
Too large (Show diff)
View
commands/digest.c
Too large (Show diff)
View
commands/dirname.c
Too large (Show diff)
View
commands/echo.c
Too large (Show diff)
View
commands/edit.c
Too large (Show diff)
View
commands/exec.c
Too large (Show diff)
View
commands/export.c
Too large (Show diff)
View
commands/false.c
Too large (Show diff)
View
commands/filetype.c
Too large (Show diff)
View
commands/flash.c
Too large (Show diff)
View
commands/global.c
Too large (Show diff)
View
commands/go.c
Too large (Show diff)
View
commands/gpio.c
Too large (Show diff)
View
commands/help.c
Too large (Show diff)
View
commands/i2c.c
Too large (Show diff)
View
commands/insmod.c
Too large (Show diff)
View
commands/iomemport.c
Too large (Show diff)
View
commands/led.c
Too large (Show diff)
View
commands/let.c
Too large (Show diff)
View
commands/linux16.c
Too large (Show diff)
View
commands/linux_exec.c
Too large (Show diff)
View
commands/ln.c
Too large (Show diff)
View
commands/loadb.c
Too large (Show diff)
View
commands/loadenv.c
Too large (Show diff)
View
commands/loads.c
Too large (Show diff)
View
commands/loadxy.c
Too large (Show diff)
View
commands/login.c
Too large (Show diff)
View
commands/ls.c
Too large (Show diff)
View
commands/lsmod.c
Too large (Show diff)
View
commands/magicvar.c
Too large (Show diff)
View
commands/md.c
Too large (Show diff)
View
commands/memcmp.c
Too large (Show diff)
View
commands/memcpy.c
Too large (Show diff)
View
commands/meminfo.c
Too large (Show diff)
View
commands/memset.c
Too large (Show diff)
View
commands/memtest.c
Too large (Show diff)
View
commands/menu.c
Too large (Show diff)
View
commands/menutree.c
Too large (Show diff)
View
commands/miitool.c
Too large (Show diff)
View
commands/mkdir.c
Too large (Show diff)
View
commands/mm.c
Too large (Show diff)
View
commands/mount.c
Too large (Show diff)
View
commands/msleep.c
Too large (Show diff)
View
commands/mw.c
Too large (Show diff)
View
commands/nand.c
Too large (Show diff)
View
commands/nandtest.c
Too large (Show diff)
View
commands/net.c
Too large (Show diff)
View
commands/of_node.c
Too large (Show diff)
View
commands/of_property.c
Too large (Show diff)
View
commands/oftree.c
Too large (Show diff)
View
commands/partition.c
Too large (Show diff)
View
commands/passwd.c
Too large (Show diff)
View
commands/poweroff.c
Too large (Show diff)
View
commands/printenv.c
Too large (Show diff)
View
commands/pwd.c
Too large (Show diff)
View
commands/readf.c
Too large (Show diff)
View
commands/readline.c
Too large (Show diff)
View
commands/readlink.c
Too large (Show diff)
View
commands/reginfo.c
Too large (Show diff)
View
commands/regulator.c
Too large (Show diff)
View
commands/reset.c
Too large (Show diff)
View
commands/rm.c
Too large (Show diff)
View
commands/rmdir.c
Too large (Show diff)
View
commands/saveenv.c
Too large (Show diff)
View
commands/setenv.c
Too large (Show diff)
View
commands/sleep.c
Too large (Show diff)
View
commands/spi.c
Too large (Show diff)
View
commands/splash.c
Too large (Show diff)
View
commands/test.c
Too large (Show diff)
View
commands/tftp.c
Too large (Show diff)
View
commands/time.c
Too large (Show diff)
View
commands/timeout.c
Too large (Show diff)
View
commands/trigger.c
Too large (Show diff)
View
commands/true.c
Too large (Show diff)
View
commands/ubi.c
Too large (Show diff)
View
commands/ubiformat.c
Too large (Show diff)
View
commands/uimage.c
Too large (Show diff)
View
commands/umount.c
Too large (Show diff)
View
commands/uncompress.c
Too large (Show diff)
View
commands/usb.c
Too large (Show diff)
View
commands/usbserial.c
Too large (Show diff)
View
commands/version.c
Too large (Show diff)
View
commands/wd.c
Too large (Show diff)
View
common/command.c
Too large (Show diff)
View
common/hush.c
Too large (Show diff)
View
drivers/gpio/gpiolib.c
Too large (Show diff)
View
drivers/mtd/nand/nand_imx_bbm.c
Too large (Show diff)
View
drivers/mtd/nand/nand_s3c24xx.c
Too large (Show diff)
View
include/command.h
Too large (Show diff)
View
net/dhcp.c
Too large (Show diff)
View
net/dns.c
Too large (Show diff)
View
net/ifup.c
Too large (Show diff)
View
net/nfs.c
Too large (Show diff)
View
net/ping.c
Too large (Show diff)