summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-12-13 20:55:48 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-12-17 21:28:41 +0100
commit0de6b6b3065bac6a0a295c12dcdced240c4eb790 (patch)
tree273e661cb82627d03ae1b210cf870a8662e044c0
parenta031331250f35e2a131ed1440bdadfe69838b84e (diff)
downloadbarebox-0de6b6b3065bac6a0a295c12dcdced240c4eb790.tar.gz
barebox-0de6b6b3065bac6a0a295c12dcdced240c4eb790.tar.xz
doc: add documentation for 'go' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--Documentation/commands.dox2
-rw-r--r--commands/go.c17
2 files changed, 13 insertions, 6 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 907818ea..430cc520 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
-@li @subpage go
+@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 02629402..cb0b72b7 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,