[PATCH 02/34] doc: add documentation for 'version' command
Robert Schwebel
r.schwebel at pengutronix.de
Wed Dec 15 06:51:16 EST 2010
Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
Documentation/commands.dox | 2 +-
commands/version.c | 15 ++++++++++++++-
2 files changed, 15 insertions(+), 2 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 5ef7829..6c2f59d 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -106,6 +106,6 @@ available in @a Barebox:
@li @subpage unlzo
@li @subpage unprotect_command
@li @subpage usb
- at li @subpage version
+ at li @subpage version_command
*/
diff --git a/commands/version.c b/commands/version.c
index 2b3ac05..baec60f 100644
--- a/commands/version.c
+++ b/commands/version.c
@@ -29,9 +29,22 @@ static int do_version(struct command *cmdtp, int argc, char *argv[])
printf ("\n%s\n", version_string);
return 0;
}
+BAREBOX_CMD_HELP_START(version)
+BAREBOX_CMD_HELP_USAGE("version\n")
+BAREBOX_CMD_HELP_SHORT("Print the Barebox version.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page version_command
+
+The version string follows the version information from the Linux
+kernel, so for code coming from git you get an information about the
+commit ID and the number of patches applied ontop of the last release.
+
+ */
BAREBOX_CMD_START(version)
.cmd = do_version,
- .usage = "print monitor version",
+ .usage = "print barebox version",
BAREBOX_CMD_END
--
1.7.2.3
More information about the barebox
mailing list