[PATCH 15/34] doc: add documentation for 'readline' command

Robert Schwebel r.schwebel at pengutronix.de
Wed Dec 15 06:51:29 EST 2010


Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/readline.c        |   14 +++++++++++---
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 04718b8..2775b2d 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
- at li @subpage readline
+ at li @subpage readline_command
 @li @subpage reset
 @li @subpage rarpboot
 @li @subpage reginfo
diff --git a/commands/readline.c b/commands/readline.c
index cf2625f..14f62dd 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,
-- 
1.7.2.3




More information about the barebox mailing list