summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-12-09 07:31:55 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-12-17 21:28:39 +0100
commite40eafe60a904bc4f1a7e1b9ec3cbb47a4d5f00a (patch)
tree6ffb49c5402ca3937991a692716d5219c5c607cb
parent469c8a80c0bebe5de0506d493d6e1e365dcdd10d (diff)
downloadbarebox-e40eafe60a904bc4f1a7e1b9ec3cbb47a4d5f00a.tar.gz
barebox-e40eafe60a904bc4f1a7e1b9ec3cbb47a4d5f00a.tar.xz
doc: add documentation for 'unlzo' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--Documentation/commands.dox2
-rw-r--r--commands/unlzo.c14
2 files changed, 12 insertions, 4 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 6c2f59d7..cc892d46 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -103,7 +103,7 @@ available in @a Barebox:
@li @subpage ubimkvol
@li @subpage ubirmvol
@li @subpage umount
-@li @subpage unlzo
+@li @subpage unlzo_command
@li @subpage unprotect_command
@li @subpage usb
@li @subpage version_command
diff --git a/commands/unlzo.c b/commands/unlzo.c
index 0b6dd4b9..40225e6d 100644
--- a/commands/unlzo.c
+++ b/commands/unlzo.c
@@ -57,9 +57,17 @@ exit_close:
return ret;
}
-static const __maybe_unused char cmd_unlzo_help[] =
-"Usage: unlzo <infile> <outfile>\n"
-"Uncompress a lzo compressed file\n";
+BAREBOX_CMD_HELP_START(unlzo)
+BAREBOX_CMD_HELP_USAGE("unlzo <infile> <outfile>\n")
+BAREBOX_CMD_HELP_SHORT("Uncompress a lzo compressed file.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page unlzo_command
+
+\todo Add an example, how to handle LZO files in RAM.
+
+ */
BAREBOX_CMD_START(unlzo)
.cmd = do_unlzo,