[PATCH 26/34] doc: add documentation for 'sh' command

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


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

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 7f4e489..438d33e 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
- at li @subpage sh
+ at 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 4947173..e269836 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
 
-- 
1.7.2.3




More information about the barebox mailing list