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>
WIP_next-LS
master
next
stable/v2014.07
stable/v2014.08
stable/v2014.09
stable/v2014.10
stable/v2014.11
stable/v2014.12
stable/v2015.01
stable/v2015.02
stable/v2017.05
stable/v2017.06
stable/v2017.07
stable/v2017.11
stable/v2018.07
stable/v2018.09
stable/v2018.12
work/fit-support
v2020.07.0
v2020.06.0
v2020.05.0
v2020.04.0
v2020.03.0
v2020.02.0
v2020.01.0
v2019.12.0
v2019.11.0
v2019.10.0
v2019.09.0
v2019.08.1
v2019.08.0
v2019.07.0
v2019.06.1
v2019.06.0
v2019.05.0
v2019.04.0
v2019.03.0
v2019.02.0
v2019.01.0
v2018.12.0
v2018.11.0
v2018.10.0
v2018.09.1
v2018.09.0
v2018.08.1
v2018.08.0
v2018.07.2
v2018.07.1
v2018.07.0
v2018.06.0
v2018.05.0
v2018.04.0
v2018.03.0
v2018.02.0
v2018.01.0
v2017.12.0
v2017.11.0
v2017.10.0
v2017.09.0
v2017.08.0
v2017.07.1
v2017.07.0
v2017.06.2
v2017.06.1
v2017.06.0
v2017.05.4
v2017.05.3
v2017.05.2
v2017.05.1
v2017.05.0
v2017.04.0
v2017.03.0
v2017.02.0
v2017.01.0
v2016.11.0
v2016.10.0
v2016.09.0
v2016.08.0
v2016.07.0
v2016.06.0
v2016.05.0
v2016.04.0
v2016.03.0
v2016.02.0
v2016.01.0
v2015.12.0
v2015.11.0
v2015.10.0
v2015.09.0
v2015.08.0
v2015.07.0
v2015.06.0
v2015.05.0
v2015.04.0
v2015.03.0
v2015.02.0
v2015.01.0
v2014.12.0
v2014.11.0
v2014.10.0
v2014.09.0
v2014.08.0
v2014.07.0
|
---|
|
arch/arm/boards/eukrea_cpuimx35/eukrea_cpuimx35.c |
---|
Too large (Show diff)
|
arch/arm/boards/guf-cupid/board.c |
---|
Too large (Show diff)
|
arch/arm/boards/phytec-phycore-imx35/pcm043.c |
---|
Too large (Show diff)
|
arch/arm/cpu/cpuinfo.c |
---|
Too large (Show diff)
|
arch/arm/cpu/mmuinfo.c |
---|
Too large (Show diff)
|
arch/arm/lib/bootu.c |
---|
Too large (Show diff)
|
arch/arm/lib/bootz.c |
---|
Too large (Show diff)
|
arch/arm/mach-at91/boot_test_cmd.c |
---|
Too large (Show diff)
|
arch/arm/mach-at91/clock.c |
---|
Too large (Show diff)
|
arch/arm/mach-at91/gpio.c |
---|
Too large (Show diff)
|
arch/arm/mach-mxs/bcb.c |
---|
Too large (Show diff)
|
arch/arm/mach-netx/generic.c |
---|
Too large (Show diff)
|
arch/arm/mach-omap/boot_order.c |
---|
Too large (Show diff)
|
arch/blackfin/boards/ipe337/cmd_alternate.c |
---|
Too large (Show diff)
|
arch/mips/lib/cpuinfo.c |
---|
Too large (Show diff)
|
arch/openrisc/lib/cpuinfo.c |
---|
Too large (Show diff)
|
commands/2048.c |
---|
Too large (Show diff)
|
commands/automount.c |
---|
Too large (Show diff)
|
commands/barebox-update.c |
---|
Too large (Show diff)
|
commands/basename.c |
---|
Too large (Show diff)
|
commands/boot.c |
---|
Too large (Show diff)
|
commands/bootm.c |
---|
Too large (Show diff)
|
commands/cat.c |
---|
Too large (Show diff)
|
commands/cd.c |
---|
Too large (Show diff)
|
commands/clear.c |
---|
Too large (Show diff)
|
commands/clk.c |
---|
Too large (Show diff)
|
commands/cp.c |
---|
Too large (Show diff)
|
commands/crc.c |
---|
Too large (Show diff)
|
commands/detect.c |
---|
Too large (Show diff)
|
commands/devinfo.c |
---|
Too large (Show diff)
|
commands/dfu.c |
---|
Too large (Show diff)
|
commands/digest.c |
---|
Too large (Show diff)
|
commands/dirname.c |
---|
Too large (Show diff)
|
commands/echo.c |
---|
Too large (Show diff)
|
commands/edit.c |
---|
Too large (Show diff)
|
commands/exec.c |
---|
Too large (Show diff)
|
commands/export.c |
---|
Too large (Show diff)
|
commands/false.c |
---|
Too large (Show diff)
|
commands/filetype.c |
---|
Too large (Show diff)
|
commands/flash.c |
---|
Too large (Show diff)
|
commands/global.c |
---|
Too large (Show diff)
|
commands/go.c |
---|
Too large (Show diff)
|
commands/gpio.c |
---|
Too large (Show diff)
|
commands/help.c |
---|
Too large (Show diff)
|
commands/i2c.c |
---|
Too large (Show diff)
|
commands/insmod.c |
---|
Too large (Show diff)
|
commands/iomemport.c |
---|
Too large (Show diff)
|
commands/led.c |
---|
Too large (Show diff)
|
commands/let.c |
---|
Too large (Show diff)
|
commands/linux16.c |
---|
Too large (Show diff)
|
commands/linux_exec.c |
---|
Too large (Show diff)
|
commands/ln.c |
---|
Too large (Show diff)
|
commands/loadb.c |
---|
Too large (Show diff)
|
commands/loadenv.c |
---|
Too large (Show diff)
|
commands/loads.c |
---|
Too large (Show diff)
|
commands/loadxy.c |
---|
Too large (Show diff)
|
commands/login.c |
---|
Too large (Show diff)
|
commands/ls.c |
---|
Too large (Show diff)
|
commands/lsmod.c |
---|
Too large (Show diff)
|
commands/magicvar.c |
---|
Too large (Show diff)
|
commands/md.c |
---|
Too large (Show diff)
|
commands/memcmp.c |
---|
Too large (Show diff)
|
commands/memcpy.c |
---|
Too large (Show diff)
|
commands/meminfo.c |
---|
Too large (Show diff)
|
commands/memset.c |
---|
Too large (Show diff)
|
commands/memtest.c |
---|
Too large (Show diff)
|
commands/menu.c |
---|
Too large (Show diff)
|
commands/menutree.c |
---|
Too large (Show diff)
|
commands/miitool.c |
---|
Too large (Show diff)
|
commands/mkdir.c |
---|
Too large (Show diff)
|
commands/mm.c |
---|
Too large (Show diff)
|
commands/mount.c |
---|
Too large (Show diff)
|
commands/msleep.c |
---|
Too large (Show diff)
|
commands/mw.c |
---|
Too large (Show diff)
|
commands/nand.c |
---|
Too large (Show diff)
|
commands/nandtest.c |
---|
Too large (Show diff)
|
commands/net.c |
---|
Too large (Show diff)
|
commands/of_node.c |
---|
Too large (Show diff)
|
commands/of_property.c |
---|
Too large (Show diff)
|
commands/oftree.c |
---|
Too large (Show diff)
|
commands/partition.c |
---|
Too large (Show diff)
|
commands/passwd.c |
---|
Too large (Show diff)
|
commands/poweroff.c |
---|
Too large (Show diff)
|
commands/printenv.c |
---|
Too large (Show diff)
|
commands/pwd.c |
---|
Too large (Show diff)
|
commands/readf.c |
---|
Too large (Show diff)
|
commands/readline.c |
---|
Too large (Show diff)
|
commands/readlink.c |
---|
Too large (Show diff)
|
commands/reginfo.c |
---|
Too large (Show diff)
|
commands/regulator.c |
---|
Too large (Show diff)
|
commands/reset.c |
---|
Too large (Show diff)
|
commands/rm.c |
---|
Too large (Show diff)
|
commands/rmdir.c |
---|
Too large (Show diff)
|
commands/saveenv.c |
---|
Too large (Show diff)
|
commands/setenv.c |
---|
Too large (Show diff)
|
commands/sleep.c |
---|
Too large (Show diff)
|
commands/spi.c |
---|
Too large (Show diff)
|
commands/splash.c |
---|
Too large (Show diff)
|
commands/test.c |
---|
Too large (Show diff)
|
commands/tftp.c |
---|
Too large (Show diff)
|
commands/time.c |
---|
Too large (Show diff)
|
commands/timeout.c |
---|
Too large (Show diff)
|
commands/trigger.c |
---|
Too large (Show diff)
|
commands/true.c |
---|
Too large (Show diff)
|
commands/ubi.c |
---|
Too large (Show diff)
|
commands/ubiformat.c |
---|
Too large (Show diff)
|
commands/uimage.c |
---|
Too large (Show diff)
|
commands/umount.c |
---|
Too large (Show diff)
|
commands/uncompress.c |
---|
Too large (Show diff)
|
commands/usb.c |
---|
Too large (Show diff)
|
commands/usbserial.c |
---|
Too large (Show diff)
|
commands/version.c |
---|
Too large (Show diff)
|
commands/wd.c |
---|
Too large (Show diff)
|
common/command.c |
---|
Too large (Show diff)
|
common/hush.c |
---|
Too large (Show diff)
|
drivers/gpio/gpiolib.c |
---|
Too large (Show diff)
|
drivers/mtd/nand/nand_imx_bbm.c |
---|
Too large (Show diff)
|
drivers/mtd/nand/nand_s3c24xx.c |
---|
Too large (Show diff)
|
include/command.h |
---|
Too large (Show diff)
|
net/dhcp.c |
---|
Too large (Show diff)
|
net/dns.c |
---|
Too large (Show diff)
|
net/ifup.c |
---|
Too large (Show diff)
|
net/nfs.c |
---|
Too large (Show diff)
|
net/ping.c |
---|
Too large (Show diff)
|