summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-12-13 21:05:26 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-12-17 21:28:41 +0100
commite1b089a07c3c836b7ac1443616123f9754e459af (patch)
tree77a51393818ae67b71e42fd8d4483214bf256826
parentc47b26546421a04f610d0c9bea5dcc1cd01d9917 (diff)
downloadbarebox-e1b089a07c3c836b7ac1443616123f9754e459af.tar.gz
barebox-e1b089a07c3c836b7ac1443616123f9754e459af.tar.xz
doc: add documentation for 'sh' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--Documentation/commands.dox2
-rw-r--r--common/hush.c15
2 files changed, 11 insertions, 6 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 7f4e4897..438d33ef 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -92,7 +92,7 @@ available in @a Barebox:
@li @subpage rmdir_command
@li @subpage saveenv_command
@li @subpage setenv_command
-@li @subpage sh
+@li @subpage sh_command
@li @subpage sleep_command
@li @subpage source_command
@li @subpage test_command
diff --git a/common/hush.c b/common/hush.c
index 49471736..e269836e 100644
--- a/common/hush.c
+++ b/common/hush.c
@@ -1670,14 +1670,19 @@ static int do_sh(struct command *cmdtp, int argc, char *argv[])
return execute_script(argv[1], argc - 1, argv + 1);
}
-static const __maybe_unused char cmd_sh_help[] =
-"Usage: sh filename [arguments]\n"
-"\n"
-"Execute a shell script\n";
+BAREBOX_CMD_HELP_START(sh)
+BAREBOX_CMD_HELP_USAGE("sh FILE [ARGS]\n")
+BAREBOX_CMD_HELP_SHORT("Execute a shell script.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page sh_command
+
+ */
BAREBOX_CMD_START(sh)
.cmd = do_sh,
- .usage = "run shell script",
+ .usage = "execute a shell script",
BAREBOX_CMD_HELP(cmd_sh_help)
BAREBOX_CMD_END