9
0
Fork 0
barebox/arch/arm/lib
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
..
.gitignore rename U-Boot-v2 project to barebox 2009-12-15 10:18:30 +01:00
Makefile ARM: compile bootm code depending on CONFIG_BOOTM 2013-09-24 09:03:18 +02:00
armlinux.c ARM: boot barebox with kernel calling convention 2014-01-06 14:25:06 +01:00
ashldi3.S Treewide: remove address of the Free Software Foundation 2012-09-17 10:57:41 +02:00
ashrdi3.S Treewide: remove address of the Free Software Foundation 2012-09-17 10:57:41 +02:00
barebox.lds.S ARM: lib: add BAREBOX_CLK_TABLE to linker script 2013-11-11 09:26:59 +01:00
bootm.c ARM: bootm: fix default uImage placement 2014-05-05 15:09:09 +02:00
bootu.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
bootz.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
copy_template.S ARM: update string functions from Linux Kernel 2012-01-02 15:00:28 +01:00
div0.c Treewide: remove address of the Free Software Foundation 2012-09-17 10:57:41 +02:00
findbit.S ARM: update string functions from Linux Kernel 2012-01-02 15:00:28 +01:00
io-readsb.S ioreadsb: put the whole ioreadsb function into the .text.readsb section 2010-02-16 21:49:33 +01:00
io-readsl.S Add IO string functions to also handle 32 bit IO locations 2009-07-01 10:45:21 +02:00
io-readsw-armv4.S Remove all ARM __raw_* functions. They are mixed all over 2009-07-01 14:35:35 +02:00
io-writesb.S Remove all ARM __raw_* functions. They are mixed all over 2009-07-01 14:35:35 +02:00
io-writesl.S Add IO string functions to also handle 32 bit IO locations 2009-07-01 10:45:21 +02:00
io-writesw-armv4.S ARM: Separate assembler functions into their own section 2012-07-23 23:57:44 +02:00
io.c ARM: import memcpy_from/toio and memset_io from linux 2012-01-02 12:08:24 +01:00
lib1funcs.S Treewide: remove address of the Free Software Foundation 2012-09-17 10:57:41 +02:00
lshrdi3.S Treewide: remove address of the Free Software Foundation 2012-09-17 10:57:41 +02:00
memcpy.S ARM: update string functions from Linux Kernel 2012-01-02 15:00:28 +01:00
memset.S ARM: fix the memset fix 2013-05-23 08:27:57 +02:00
module.c ARM: Using unsigned specifiers for unsigned arguments for printf 2013-05-31 08:53:51 +02:00
pbl.lds.S Load PBL into SRAM 2014-02-09 09:43:33 +01:00
runtime-offset.S ARM: Add image end section 2013-06-26 23:43:19 +02:00
unwind.c include asm/sections.h instead of asm-generic/sections.h 2013-03-10 11:05:46 +01:00