[PATCH 24/34] doc: add documentation for 'go' command

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


Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/go.c              |   17 ++++++++++++-----
 2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 907818e..430cc52 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -49,7 +49,7 @@ available in @a Barebox:
 @li @subpage gpio_set_value_command
 @li @subpage gpio_direction_input_command
 @li @subpage gpio_direction_output_command
- at li @subpage go
+ at li @subpage go_command
 @li @subpage help_command
 @li @subpage host
 @li @subpage i2c_probe
diff --git a/commands/go.c b/commands/go.c
index 0262940..cb0b72b 100644
--- a/commands/go.c
+++ b/commands/go.c
@@ -77,11 +77,18 @@ out:
 	return rcode;
 }
 
-static const __maybe_unused char cmd_go_help[] =
-"Usage: go addr [arg ...]\n"
-"Start application at address 'addr' passing 'arg' as arguments.\n"
-"If addr does not start with a digit it is interpreted as a filename\n"
-"in which case the file is memmapped and executed\n";
+BAREBOX_CMD_HELP_START(go)
+BAREBOX_CMD_HELP_USAGE("go ADDR [ARGS]\n")
+BAREBOX_CMD_HELP_SHORT("Start application at address ADDR, passing ARGS as arguments.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page go_command
+
+If ADDR does not start with a digit, it is interpreted as a filename. In
+this case the file is memory mapped and executed.
+
+ */
 
 BAREBOX_CMD_START(go)
 	.cmd		= do_go,
-- 
1.7.2.3




More information about the barebox mailing list