[PATCH 03/34] doc: add documentation for 'unlzo' command

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


Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/unlzo.c           |   14 +++++++++++---
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 6c2f59d..cc892d4 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
- at li @subpage unlzo
+ at 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 0b6dd4b..40225e6 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,
-- 
1.7.2.3




More information about the barebox mailing list