diff options
author | Holger Schurig <holgerschurig@gmail.com> | 2014-05-13 10:28:42 +0200 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2014-05-14 10:03:43 +0200 |
commit | f1f532084a6e9ee8225f047353999b459455df7e (patch) | |
tree | f2b8b1f25c5c630209c6970e3a7ce57a3d55d367 /commands/linux16.c | |
parent | ab23d0bb3f66cfb7a97a8aa6b8007687ed7a6925 (diff) | |
download | barebox-f1f532084a6e9ee8225f047353999b459455df7e.tar.gz barebox-f1f532084a6e9ee8225f047353999b459455df7e.tar.xz |
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>
Diffstat (limited to 'commands/linux16.c')
-rw-r--r-- | commands/linux16.c | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/commands/linux16.c b/commands/linux16.c index ac1265ae35..65814f4ce7 100644 --- a/commands/linux16.c +++ b/commands/linux16.c @@ -318,9 +318,16 @@ on_error: } BAREBOX_CMD_HELP_START(linux16) -BAREBOX_CMD_HELP_USAGE("linux16 <file> [-v <mode>]\n") -BAREBOX_CMD_HELP_SHORT("Boot a kernel <file> on x86 via real mode code.\n") -BAREBOX_CMD_HELP_OPT ("-v <mode>", "VESA video mode number or 'ask'\n") +BAREBOX_CMD_HELP_TEXT("Load kernel from FILE and boot on x86 in real-mode.") +BAREBOX_CMD_HELP_TEXT("") +BAREBOX_CMD_HELP_TEXT("Only kernel images in bzImage format are supported by now.") +BAREBOX_CMD_HELP_TEXT("") +BAREBOX_CMD_HELP_TEXT("For the video mode refer the Linux kernel documentation") +BAREBOX_CMD_HELP_TEXT("'Documentation/fb/vesafb.txt' for correct VESA mode numbers. Use 'ask'") +BAREBOX_CMD_HELP_TEXT("instead of a number to make Linux for options..") +BAREBOX_CMD_HELP_TEXT("") +BAREBOX_CMD_HELP_TEXT("Options:") +BAREBOX_CMD_HELP_OPT ("-v VESAMODE", "set VESAMODE") BAREBOX_CMD_HELP_END /** @@ -337,7 +344,8 @@ x86_boot_preparation for more info about how to use this command.</p> BAREBOX_CMD_START(linux16) .cmd = do_linux16, - .usage = "boot a linux kernel", + BAREBOX_CMD_DESC("boot a linux kernel on x86 via real-mode code") + BAREBOX_CMD_OPTS("[-v VESAMODE] FILE") BAREBOX_CMD_GROUP(CMD_GRP_BOOT) BAREBOX_CMD_HELP(cmd_linux16_help) BAREBOX_CMD_END |