diff options
| author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-10 22:12:54 +0100 |
|---|---|---|
| committer | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-17 21:28:40 +0100 |
| commit | 36631a8c16996605397cf02f36850af1a95700dd (patch) | |
| tree | 4cedeb6c5b289aad5bfc8eefd6fc3747faba8ca7 | |
| parent | d881f614b756a63b5b8ffb8f54a3de46702ed4e9 (diff) | |
| download | barebox-36631a8c16996605397cf02f36850af1a95700dd.tar.gz barebox-36631a8c16996605397cf02f36850af1a95700dd.tar.xz | |
doc: add documentation for 'help' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
| -rw-r--r-- | Documentation/commands.dox | 2 | ||||
| -rw-r--r-- | commands/help.c | 22 |
2 files changed, 16 insertions, 8 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox index cf45b146..887c58f8 100644 --- a/Documentation/commands.dox +++ b/Documentation/commands.dox @@ -50,7 +50,7 @@ available in @a Barebox: @li @subpage gpio_direction_input_command @li @subpage gpio_direction_output_command @li @subpage go -@li @subpage help +@li @subpage help_command @li @subpage host @li @subpage i2c_probe @li @subpage i2c_read diff --git a/commands/help.c b/commands/help.c index f8387bd6..6d6e8e64 100644 --- a/commands/help.c +++ b/commands/help.c @@ -52,15 +52,23 @@ static int do_help(struct command * cmdtp, int argc, char *argv[]) } } -static const __maybe_unused char cmd_help_help[] = -"Show help information (for 'command')\n" -"'help' prints online help for the monitor commands.\n\n" -"Without arguments, it prints a short usage message for all commands.\n\n" -"To get detailed help information for specific commands you can type\n" -"'help' with one or more command names as arguments.\n"; - static const char *help_aliases[] = { "?", NULL}; +BAREBOX_CMD_HELP_START(help) +BAREBOX_CMD_HELP_USAGE("help COMMAND\n") +BAREBOX_CMD_HELP_SHORT("Show help information for 'command'.\n") +BAREBOX_CMD_HELP_END + +/** + * @page help_command + +'help' prints online help for the barebox commands. Without arguments, +it prints a shoft usage message for all commands. To get detailed help +information for specific commands, you can type 'help' with one or more +command names as arguments. + + */ + BAREBOX_CMD_START(help) .cmd = do_help, .aliases = help_aliases, |