[PATCH 13/34] doc: add documentation for 'test' command
Robert Schwebel
r.schwebel at pengutronix.de
Wed Dec 15 06:51:27 EST 2010
Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
Documentation/commands.dox | 2 +-
commands/test.c | 16 ++++++++++------
2 files changed, 11 insertions(+), 7 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 45947e9..0293edc 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -95,7 +95,7 @@ available in @a Barebox:
@li @subpage sh
@li @subpage sleep_command
@li @subpage source
- at li @subpage test
+ at li @subpage test_command
@li @subpage timeout_command
@li @subpage true_command
@li @subpage tftp_command
diff --git a/commands/test.c b/commands/test.c
index 4af3515..89a1764 100644
--- a/commands/test.c
+++ b/commands/test.c
@@ -222,16 +222,20 @@ out:
static const char *test_aliases[] = { "[", NULL};
-static const __maybe_unused char cmd_test_help[] =
-"Usage: test [OPTIONS]\n"
-"options: !, =, !=, -eq, -ne, -ge, -gt, -le, -lt, -o, -a, -z, -n, -d, -e, -f\n"
-"see 'man test' on your PC for more information.\n";
+BAREBOX_CMD_HELP_START(test)
+BAREBOX_CMD_HELP_USAGE("test [OPTIONS]\n")
+BAREBOX_CMD_HELP_SHORT("!, =, !=, -eq, -ne, -ge, -gt, -le, -lt, -o, -a, -z, -n, -d, -e, -f\n")
+BAREBOX_CMD_HELP_END
-static const __maybe_unused char cmd_test_usage[] = "minimal test like /bin/sh";
+/**
+ * @page test_command
+
+See 'man test' on your PC for more information.
+ */
BAREBOX_CMD_START(test)
.aliases = test_aliases,
.cmd = do_test,
- .usage = cmd_test_usage,
+ .usage = "test for a condition",
BAREBOX_CMD_HELP(cmd_test_help)
BAREBOX_CMD_END
--
1.7.2.3
More information about the barebox
mailing list