diff options
| author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-10 22:03:33 +0100 |
|---|---|---|
| committer | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-17 21:28:40 +0100 |
| commit | 0246d50afaa2d367edb36bab90a08cd353cae979 (patch) | |
| tree | 1996805200ace5cc5d2cc8f23f18f95a67757aa4 | |
| parent | 31bc6437c9ea3f710c6817f7d1642cfc19004504 (diff) | |
| download | barebox-0246d50afaa2d367edb36bab90a08cd353cae979.tar.gz barebox-0246d50afaa2d367edb36bab90a08cd353cae979.tar.xz | |
doc: add documentation for 'readline' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
| -rw-r--r-- | Documentation/commands.dox | 2 | ||||
| -rw-r--r-- | commands/readline.c | 14 |
2 files changed, 12 insertions, 4 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox index 04718b83..2775b2d9 100644 --- a/Documentation/commands.dox +++ b/Documentation/commands.dox @@ -84,7 +84,7 @@ available in @a Barebox: @li @subpage printenv_command @li @subpage protect_command @li @subpage pwd -@li @subpage readline +@li @subpage readline_command @li @subpage reset @li @subpage rarpboot @li @subpage reginfo diff --git a/commands/readline.c b/commands/readline.c index cf2625ff..14f62ddc 100644 --- a/commands/readline.c +++ b/commands/readline.c @@ -45,9 +45,17 @@ static int do_readline(struct command *cmdtp, int argc, char *argv[]) return 0; } -static const __maybe_unused char cmd_readline_help[] = -"Usage: readline <prompt> VAR\n" -"readline reads a line of user input into variable VAR.\n"; +BAREBOX_CMD_HELP_START(readline) +BAREBOX_CMD_HELP_USAGE("readline [PROMPT] VAR\n") +BAREBOX_CMD_HELP_SHORT("Read a line of user input into variable VAR.\n") +BAREBOX_CMD_HELP_END + +/** + * @page readline_command + +\todo Add example. + + */ BAREBOX_CMD_START(readline) .cmd = do_readline, |