9
0
Fork 0
barebox/net
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
..
Kconfig net: Add ifup support 2014-03-07 07:41:36 +01:00
Makefile net: Add ifup support 2014-03-07 07:41:36 +01:00
dhcp.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
dns.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
eth.c param: Add dev_add_param_mac 2014-04-04 09:04:31 +02:00
ifup.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
net.c net: Fix error return value for string_to_ethaddr 2014-01-20 14:13:00 +01:00
netconsole.c netconsole: bail out when no connection is opened 2014-03-31 09:19:35 +02:00
nfs.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
nfs.h pass filename to nfs and tftp start functions 2009-10-19 10:18:51 +02:00
ping.c commands: harmonize in-barebox documentation 2014-05-14 10:03:43 +02:00
rarp.h Treewide: remove address of the Free Software Foundation 2012-09-17 10:57:41 +02:00