summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-12-09 07:26:12 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-12-17 21:28:39 +0100
commit469c8a80c0bebe5de0506d493d6e1e365dcdd10d (patch)
tree8f017e944bc5c6f1a47ad6d84adb4d091d333c34
parent7e3b5ab8f535b1d6ff92660226cf06953d192e7a (diff)
downloadbarebox-469c8a80c0bebe5de0506d493d6e1e365dcdd10d.tar.gz
barebox-469c8a80c0bebe5de0506d493d6e1e365dcdd10d.tar.xz
doc: add documentation for 'version' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--Documentation/commands.dox2
-rw-r--r--commands/version.c15
2 files changed, 15 insertions, 2 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 5ef7829a..6c2f59d7 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
-@li @subpage version
+@li @subpage version_command
*/
diff --git a/commands/version.c b/commands/version.c
index 2b3ac05c..baec60f6 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