More Documentation Patches

More Documentation Patches

[Robert Schwebel]

Hi,

I've added more documentation for the commands available in Barebox.
While being there, I'm collecting things where I think we should add
more examples etc; those are marked with \todos in order to find them
quickly. The series is not complete yet, more patches will follow.

The following changes since commit 615076e1fc11a86efdc76c64ce65cd336684c742:

  cfi_flash_amd: Add manufacturer-specific fixups (2010-12-03 01:53:14 +0800)

are available in the git repository at:
  git://git.pengutronix.de/git/rsc/barebox.git for-mainline-doc

Robert Schwebel (34):
      doc: remove non-existing references
      doc: add documentation for 'version' command
      doc: add documentation for 'unlzo' command
      doc: add documentation for 'umount' command
      doc: add documentation for 'usb' command
      doc: add documentation for ubi commands
      doc: add documentation for 'timeout' command
      doc: add documentation for 'true' command
      doc: add documentation for 'sleep' command
      doc: add documentation for 'rm' command
      doc: add documentation for 'rmdir' command
      doc: add documentation for 'mkdir' command
      doc: add documentation for 'test' command
      doc: add documentation for 'lsmod' command
      doc: add documentation for 'readline' command
      doc: add documentation for 'insmod' command
      doc: add documentation for 'help' command
      doc: add documentation for 'pwd' command
      doc: add documentation for 'false' command
      doc: add documentation for 'exec' command
      doc: add documentation for 'reset' command
      doc: add documentation for 'reginfo' command
      doc: add documentation for 'meminfo' command
      doc: add documentation for 'go' command
      doc: add documentation for 'source' command
      doc: add documentation for 'sh' command
      doc: add documentation for 'ping' command
      doc: add documentation for 'nfs' command
      doc: add documentation for 'rarpboot' command
      doc: add documentation for 'passwd' command
      doc: add documentation for 'nand' command
      doc: add documentation for 'mw' command
      doc: add documentation for 'memcmp' command
      doc: add documentation for 'md' command

 Documentation/commands.dox  |   70 +++++++++++++++++-----------------
 Doxyfile                    |    3 +-
 arch/arm/mach-omap/syslib.c |    2 +-
 commands/exec.c             |    5 ++
 commands/false.c            |    5 ++
 commands/go.c               |   17 ++++++--
 commands/help.c             |   22 +++++++---
 commands/insmod.c           |   13 +++++-
 commands/lsmod.c            |    5 ++
 commands/mem.c              |   90 +++++++++++++++++++++++++-----------------
 commands/meminfo.c          |    5 ++
 commands/mkdir.c            |   16 ++++++-
 commands/nand.c             |   22 +++++++---
 commands/net.c              |   19 ++++++++-
 commands/passwd.c           |   18 ++++++--
 commands/pwd.c              |    5 ++
 commands/readline.c         |   14 +++++-
 commands/reginfo.c          |   12 ++++++
 commands/reset.c            |    5 ++
 commands/rm.c               |    7 ++-
 commands/rmdir.c            |    7 ++-
 commands/sleep.c            |    5 ++
 commands/test.c             |   16 +++++---
 commands/timeout.c          |   23 +++++++----
 commands/true.c             |    5 ++
 commands/ubi.c              |   39 ++++++++++++++-----
 commands/umount.c           |   14 +++++-
 commands/unlzo.c            |   14 +++++-
 commands/version.c          |   15 +++++++-
 common/hush.c               |   37 ++++++++++-------
 drivers/usb/core/usb.c      |   14 +++++-
 net/nfs.c                   |   14 +++++-
 net/ping.c                  |   16 ++++++++
 33 files changed, 407 insertions(+), 167 deletions(-)



_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 01/34] doc: remove non-existing references

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 arch/arm/mach-omap/syslib.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/arch/arm/mach-omap/syslib.c b/arch/arm/mach-omap/syslib.c
index 2b25dc1..5757574 100644
--- a/arch/arm/mach-omap/syslib.c
+++ b/arch/arm/mach-omap/syslib.c
@@ -40,7 +40,7 @@
  *
  * Will be constant time as its generally used in bypass conditions only.
  * This is necessary until timers are accessible. if you need timed delays
- * use @ref mdelay or @ref udelay instead
+ * use mdelay or udelay instead
  *
  * @param[in] loops number of loops
  *
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 02/34] doc: add documentation for 'version' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@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
-@li @subpage version
+@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


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

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

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@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
-@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 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


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 04/34] doc: add documentation for 'umount' command

[Robert Schwebel]

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

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index cc892d4..07ae9d2 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -102,7 +102,7 @@ available in @a Barebox:
 @li @subpage ubiattach
 @li @subpage ubimkvol
 @li @subpage ubirmvol
-@li @subpage umount
+@li @subpage umount_command
 @li @subpage unlzo_command
 @li @subpage unprotect_command
 @li @subpage usb
diff --git a/commands/umount.c b/commands/umount.c
index 6ae5844..5295604 100644
--- a/commands/umount.c
+++ b/commands/umount.c
@@ -38,9 +38,17 @@ static int do_umount(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_umount_help[] =
-"Usage: umount <mountpoint>\n"
-"umount a filesystem mounted on a specific mountpoint\n";
+BAREBOX_CMD_HELP_START(umount)
+BAREBOX_CMD_HELP_USAGE("umount <mountpoint>\n")
+BAREBOX_CMD_HELP_SHORT("Unmount a filesystem mounted on a specific mountpoint.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page umount_command
+
+\todo Add an example
+
+ */
 
 BAREBOX_CMD_START(umount)
 	.cmd		= do_umount,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 05/34] doc: add documentation for 'usb' command

[Robert Schwebel]

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

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 07ae9d2..d5536d3 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -105,7 +105,7 @@ available in @a Barebox:
 @li @subpage umount_command
 @li @subpage unlzo_command
 @li @subpage unprotect_command
-@li @subpage usb
+@li @subpage usb_command
 @li @subpage version_command
 
 */
diff --git a/drivers/usb/core/usb.c b/drivers/usb/core/usb.c
index 76e033e..38042a5 100644
--- a/drivers/usb/core/usb.c
+++ b/drivers/usb/core/usb.c
@@ -488,9 +488,17 @@ static int do_usb(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_usb_help[] =
-"Usage: usb\n"
-"(re-)detect USB devices\n";
+BAREBOX_CMD_HELP_START(usb)
+BAREBOX_CMD_HELP_USAGE("usb\n")
+BAREBOX_CMD_HELP_SHORT("(re-)detect USB devices.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page usb_command
+
+\todo add examples
+
+ */
 
 BAREBOX_CMD_START(usb)
 	.cmd		= do_usb,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 06/34] doc: add documentation for ubi commands

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    6 +++---
 commands/ubi.c             |   39 +++++++++++++++++++++++++++++----------
 2 files changed, 32 insertions(+), 13 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index d5536d3..56edb43 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -99,9 +99,9 @@ available in @a Barebox:
 @li @subpage timeout
 @li @subpage true
 @li @subpage tftp_command
-@li @subpage ubiattach
-@li @subpage ubimkvol
-@li @subpage ubirmvol
+@li @subpage ubiattach_command
+@li @subpage ubimkvol_command
+@li @subpage ubirmvol_command
 @li @subpage umount_command
 @li @subpage unlzo_command
 @li @subpage unprotect_command
diff --git a/commands/ubi.c b/commands/ubi.c
index 3da0835..d896385 100644
--- a/commands/ubi.c
+++ b/commands/ubi.c
@@ -44,10 +44,17 @@ static int do_ubimkvol(struct command *cmdtp, int argc, char *argv[])
 	return ret ? 1 : 0;
 }
 
-static const __maybe_unused char cmd_ubimkvol_help[] =
-"Usage: ubimkvol <ubidev> <name> <size>\n"
-"Create an ubi volume on <ubidev> with name <name> and size <size>\n"
-"If size os zero all available space is used for the volume\n";
+BAREBOX_CMD_HELP_START(ubimkvol)
+BAREBOX_CMD_HELP_USAGE("ubimkvol <ubidev> <name> <size>\n")
+BAREBOX_CMD_HELP_SHORT("Create an ubi volume on <ubidev> with <name> and <size>.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page ubimkvol_command
+
+If size is zero, all available space is used for the volume.
+
+ */
 
 BAREBOX_CMD_START(ubimkvol)
 	.cmd		= do_ubimkvol,
@@ -82,9 +89,15 @@ static int do_ubiattach(struct command *cmdtp, int argc, char *argv[])
 	return ret ? 1 : 0;
 }
 
-static const __maybe_unused char cmd_ubiattach_help[] =
-"Usage: ubiattach <mtddev>\n"
-"Attach <mtddev> to ubi\n";
+BAREBOX_CMD_HELP_START(ubiattach)
+BAREBOX_CMD_HELP_USAGE("ubiattach <mtddev>\n")
+BAREBOX_CMD_HELP_SHORT("Attach <mtddev> to ubi.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page ubiattach_command
+
+ */
 
 BAREBOX_CMD_START(ubiattach)
 	.cmd		= do_ubiattach,
@@ -117,9 +130,15 @@ static int do_ubirmvol(struct command *cmdtp, int argc, char *argv[])
 	return ret ? 1 : 0;
 }
 
-static const __maybe_unused char cmd_ubirmvol_help[] =
-"Usage: ubirmvol <ubidev> <name>\n"
-"Delete ubi volume <name> from <ubidev>\n";
+BAREBOX_CMD_HELP_START(ubirmvol)
+BAREBOX_CMD_HELP_USAGE("ubirmvol <ubidev> <name>\n")
+BAREBOX_CMD_HELP_SHORT("Delete ubi volume <name> from <ubidev>.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page ubirmvol_command
+
+ */
 
 BAREBOX_CMD_START(ubirmvol)
 	.cmd		= do_ubirmvol,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 07/34] doc: add documentation for 'timeout' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/timeout.c         |   23 +++++++++++++++--------
 2 files changed, 16 insertions(+), 9 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 56edb43..e25dda0 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -96,7 +96,7 @@ available in @a Barebox:
 @li @subpage sleep
 @li @subpage source
 @li @subpage test
-@li @subpage timeout
+@li @subpage timeout_command
 @li @subpage true
 @li @subpage tftp_command
 @li @subpage ubiattach_command
diff --git a/commands/timeout.c b/commands/timeout.c
index 5f2ab9a..71a7716 100644
--- a/commands/timeout.c
+++ b/commands/timeout.c
@@ -93,14 +93,21 @@ out:
 	return ret;
 }
 
-static const __maybe_unused char cmd_timeout_help[] =
-"Usage: timeout [OPTION]... <timeout>\n"
-"Wait <timeout> seconds for a timeout. Return 1 if the user intervented\n"
-"or 0 if a timeout occured\n"
-"  -a  interrupt on any key\n"
-"  -c  interrupt on ctrl-c\n"
-"  -r  interrupt on return\n"
-"  -s  silent mode\n";
+BAREBOX_CMD_HELP_START(timeout)
+BAREBOX_CMD_HELP_USAGE("timeout [OPTIONS] <timeout>\n")
+BAREBOX_CMD_HELP_SHORT("Wait <timeout> seconds for a timeout, return 1 on user intervention and 0 on timeout.\n")
+BAREBOX_CMD_HELP_OPT  ("-a",        "interrupt on any key\n")
+BAREBOX_CMD_HELP_OPT  ("-c",        "interrupt on ctrl-c\n")
+BAREBOX_CMD_HELP_OPT  ("-r",        "interrupt on return\n")
+BAREBOX_CMD_HELP_OPT  ("-s",        "silent mode\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page timeout_command
+
+\todo Add an example
+
+ */
 
 BAREBOX_CMD_START(timeout)
 	.cmd		= do_timeout,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 08/34] doc: add documentation for 'true' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/true.c            |    5 +++++
 2 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index e25dda0..9348743 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -97,7 +97,7 @@ available in @a Barebox:
 @li @subpage source
 @li @subpage test
 @li @subpage timeout_command
-@li @subpage true
+@li @subpage true_command
 @li @subpage tftp_command
 @li @subpage ubiattach_command
 @li @subpage ubimkvol_command
diff --git a/commands/true.c b/commands/true.c
index 8c77dec..d77a365 100644
--- a/commands/true.c
+++ b/commands/true.c
@@ -29,6 +29,11 @@ static int do_true(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
+BAREBOX_CMD_HELP_START(true)
+BAREBOX_CMD_HELP_USAGE("true\n")
+BAREBOX_CMD_HELP_SHORT("Do nothing, successfully.\n")
+BAREBOX_CMD_HELP_END
+
 BAREBOX_CMD_START(true)
 	.cmd		= do_true,
 	.usage		= "do nothing, successfully",
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 09/34] doc: add documentation for 'sleep' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/sleep.c           |    5 +++++
 2 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 9348743..6598002 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -93,7 +93,7 @@ available in @a Barebox:
 @li @subpage saveenv_command
 @li @subpage setenv_command
 @li @subpage sh
-@li @subpage sleep
+@li @subpage sleep_command
 @li @subpage source
 @li @subpage test
 @li @subpage timeout_command
diff --git a/commands/sleep.c b/commands/sleep.c
index 40a3a47..972afd6 100644
--- a/commands/sleep.c
+++ b/commands/sleep.c
@@ -43,6 +43,11 @@ static int do_sleep(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
+BAREBOX_CMD_HELP_START(sleep)
+BAREBOX_CMD_HELP_USAGE("sleep <n>\n")
+BAREBOX_CMD_HELP_SHORT("Delay execution for <n> seconds.\n")
+BAREBOX_CMD_HELP_END
+
 BAREBOX_CMD_START(sleep)
 	.cmd		= do_sleep,
 	.usage		= "delay execution for n seconds",
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 10/34] doc: add documentation for 'rm' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/rm.c              |    7 ++++---
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 6598002..b0919d0 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -88,7 +88,7 @@ available in @a Barebox:
 @li @subpage reset
 @li @subpage rarpboot
 @li @subpage reginfo
-@li @subpage rm
+@li @subpage rm_command
 @li @subpage rmdir
 @li @subpage saveenv_command
 @li @subpage setenv_command
diff --git a/commands/rm.c b/commands/rm.c
index 3437ae5..4a45fee 100644
--- a/commands/rm.c
+++ b/commands/rm.c
@@ -42,9 +42,10 @@ static int do_rm(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_rm_help[] =
-"Usage: rm [FILES]\n"
-"Remove files\n";
+BAREBOX_CMD_HELP_START(rm)
+BAREBOX_CMD_HELP_USAGE("rm FILE\n")
+BAREBOX_CMD_HELP_SHORT("Remove files.\n")
+BAREBOX_CMD_HELP_END
 
 BAREBOX_CMD_START(rm)
 	.cmd		= do_rm,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 11/34] doc: add documentation for 'rmdir' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/rmdir.c           |    7 ++++---
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index b0919d0..db3be1a 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -89,7 +89,7 @@ available in @a Barebox:
 @li @subpage rarpboot
 @li @subpage reginfo
 @li @subpage rm_command
-@li @subpage rmdir
+@li @subpage rmdir_command
 @li @subpage saveenv_command
 @li @subpage setenv_command
 @li @subpage sh
diff --git a/commands/rmdir.c b/commands/rmdir.c
index 83a0b02..0a8838b 100644
--- a/commands/rmdir.c
+++ b/commands/rmdir.c
@@ -21,9 +21,10 @@ static int do_rmdir(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_rmdir_help[] =
-"Usage: rmdir [directories]\n"
-"Remove directories. The directories have to be empty.\n";
+BAREBOX_CMD_HELP_START(rmdir)
+BAREBOX_CMD_HELP_USAGE("rmdir DIRECTORIES\n")
+BAREBOX_CMD_HELP_SHORT("Remove directories. The directories have to be empty.\n")
+BAREBOX_CMD_HELP_END
 
 BAREBOX_CMD_START(rmdir)
 	.cmd		= do_rmdir,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 12/34] doc: add documentation for 'mkdir' command

[Robert Schwebel]

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

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index db3be1a..45947e9 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -71,7 +71,7 @@ available in @a Barebox:
 @li @subpage meminfo
 @li @subpage memset
 @li @subpage menu
-@li @subpage mkdir
+@li @subpage mkdir_command
 @li @subpage mount_command
 @li @subpage mtest
 @li @subpage mw
diff --git a/commands/mkdir.c b/commands/mkdir.c
index b66795b..9e37775 100644
--- a/commands/mkdir.c
+++ b/commands/mkdir.c
@@ -59,9 +59,19 @@ static int do_mkdir(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_mkdir_help[] =
-"Usage: mkdir [directories]\n"
-"Create new directories\n";
+BAREBOX_CMD_HELP_START(mkdir)
+BAREBOX_CMD_HELP_USAGE("mkdir DIRECTORIES\n")
+BAREBOX_CMD_HELP_SHORT("Create new directories.\n")
+BAREBOX_CMD_HELP_OPT  ("-p", "create all parent directories\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page mkdir_command
+
+When called with the '-p' option, mkdir creates all non-existing parent
+directories.
+
+ */
 
 BAREBOX_CMD_START(mkdir)
 	.cmd		= do_mkdir,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 13/34] doc: add documentation for 'test' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@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
-@li @subpage test
+@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


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 14/34] doc: add documentation for 'lsmod' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/lsmod.c           |    5 +++++
 2 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 0293edc..04718b8 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -65,7 +65,7 @@ available in @a Barebox:
 @li @subpage loadxc
 @li @subpage login
 @li @subpage ls_command
-@li @subpage lsmod
+@li @subpage lsmod_command
 @li @subpage md
 @li @subpage memcmp
 @li @subpage meminfo
diff --git a/commands/lsmod.c b/commands/lsmod.c
index 26d2fe4..9a90e88 100644
--- a/commands/lsmod.c
+++ b/commands/lsmod.c
@@ -12,6 +12,11 @@ static int do_lsmod(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
+BAREBOX_CMD_HELP_START(lsmod)
+BAREBOX_CMD_HELP_USAGE("lsmod\n")
+BAREBOX_CMD_HELP_SHORT("List modules.\n")
+BAREBOX_CMD_HELP_END
+
 BAREBOX_CMD_START(lsmod)
 	.cmd		= do_lsmod,
 	.usage		= "list modules",
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 15/34] doc: add documentation for 'readline' command

[Robert Schwebel]

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

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 04718b8..2775b2d 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -84,7 +84,7 @@ available in @a Barebox:
 @li @subpage printenv_command
 @li @subpage protect_command
 @li @subpage pwd
-@li @subpage readline
+@li @subpage readline_command
 @li @subpage reset
 @li @subpage rarpboot
 @li @subpage reginfo
diff --git a/commands/readline.c b/commands/readline.c
index cf2625f..14f62dd 100644
--- a/commands/readline.c
+++ b/commands/readline.c
@@ -45,9 +45,17 @@ static int do_readline(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_readline_help[] =
-"Usage: readline <prompt> VAR\n"
-"readline reads a line of user input into variable VAR.\n";
+BAREBOX_CMD_HELP_START(readline)
+BAREBOX_CMD_HELP_USAGE("readline [PROMPT] VAR\n")
+BAREBOX_CMD_HELP_SHORT("Read a line of user input into variable VAR.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page readline_command
+
+\todo Add example.
+
+ */
 
 BAREBOX_CMD_START(readline)
 	.cmd		= do_readline,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 16/34] doc: add documentation for 'insmod' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/insmod.c          |   13 +++++++++++--
 2 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 2775b2d..cf45b14 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -57,7 +57,7 @@ available in @a Barebox:
 @li @subpage i2c_write
 @li @subpage icache
 @li @subpage iminfo
-@li @subpage insmod
+@li @subpage insmod_command
 @li @subpage linux16_command
 @li @subpage loadenv_command
 @li @subpage loadb
diff --git a/commands/insmod.c b/commands/insmod.c
index d3b4d1a..65a7d36 100644
--- a/commands/insmod.c
+++ b/commands/insmod.c
@@ -32,8 +32,17 @@ static int do_insmod(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_insmod_help[] =
-"Usage: insmod <module>\n"; 
+BAREBOX_CMD_HELP_START(insmod)
+BAREBOX_CMD_HELP_USAGE("insmod MODULE\n")
+BAREBOX_CMD_HELP_SHORT("Insert a module.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page insmod_command
+
+\todo Add example for module handling.
+
+ */
 
 BAREBOX_CMD_START(insmod)
 	.cmd		= do_insmod,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 17/34] doc: add documentation for 'help' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/help.c            |   22 +++++++++++++++-------
 2 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index cf45b14..887c58f 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -50,7 +50,7 @@ available in @a Barebox:
 @li @subpage gpio_direction_input_command
 @li @subpage gpio_direction_output_command
 @li @subpage go
-@li @subpage help
+@li @subpage help_command
 @li @subpage host
 @li @subpage i2c_probe
 @li @subpage i2c_read
diff --git a/commands/help.c b/commands/help.c
index f8387bd..6d6e8e6 100644
--- a/commands/help.c
+++ b/commands/help.c
@@ -52,15 +52,23 @@ static int do_help(struct command * cmdtp, int argc, char *argv[])
 	}
 }
 
-static const __maybe_unused char cmd_help_help[] =
-"Show help information (for 'command')\n"
-"'help' prints online help for the monitor commands.\n\n"
-"Without arguments, it prints a short usage message for all commands.\n\n"
-"To get detailed help information for specific commands you can type\n"
-"'help' with one or more command names as arguments.\n";
-
 static const char *help_aliases[] = { "?", NULL};
 
+BAREBOX_CMD_HELP_START(help)
+BAREBOX_CMD_HELP_USAGE("help COMMAND\n")
+BAREBOX_CMD_HELP_SHORT("Show help information for 'command'.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page help_command
+
+'help' prints online help for the barebox commands. Without arguments,
+it prints a shoft usage message for all commands. To get detailed help
+information for specific commands, you can type 'help' with one or more
+command names as arguments.
+
+ */
+
 BAREBOX_CMD_START(help)
 	.cmd		= do_help,
 	.aliases	= help_aliases,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 18/34] doc: add documentation for 'pwd' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/pwd.c             |    5 +++++
 2 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 887c58f..cf91a49 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -83,7 +83,7 @@ available in @a Barebox:
 @li @subpage ping
 @li @subpage printenv_command
 @li @subpage protect_command
-@li @subpage pwd
+@li @subpage pwd_command
 @li @subpage readline_command
 @li @subpage reset
 @li @subpage rarpboot
diff --git a/commands/pwd.c b/commands/pwd.c
index d51fa1a..2d5afb5 100644
--- a/commands/pwd.c
+++ b/commands/pwd.c
@@ -29,6 +29,11 @@ static int do_pwd(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
+BAREBOX_CMD_HELP_START(pwd)
+BAREBOX_CMD_HELP_USAGE("pwd\n")
+BAREBOX_CMD_HELP_SHORT("Print working directory.\n")
+BAREBOX_CMD_HELP_END
+
 BAREBOX_CMD_START(pwd)
 	.cmd		= do_pwd,
 	.usage		= "print working directory",
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 19/34] doc: add documentation for 'false' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/false.c           |    5 +++++
 2 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index cf91a49..087ab4e 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -43,7 +43,7 @@ available in @a Barebox:
 @li @subpage exec
 @li @subpage exit
 @li @subpage export_command
-@li @subpage false
+@li @subpage false_command
 @li @subpage getopt
 @li @subpage gpio_get_value_command
 @li @subpage gpio_set_value_command
diff --git a/commands/false.c b/commands/false.c
index a90eadc..b7e3983 100644
--- a/commands/false.c
+++ b/commands/false.c
@@ -29,6 +29,11 @@ static int do_false(struct command *cmdtp, int argc, char *argv[])
 	return 1;
 }
 
+BAREBOX_CMD_HELP_START(false)
+BAREBOX_CMD_HELP_USAGE("false\n")
+BAREBOX_CMD_HELP_SHORT("Do nothing, unsuccessfully.\n")
+BAREBOX_CMD_HELP_END
+
 BAREBOX_CMD_START(false)
 	.cmd		= do_false,
 	.usage		= "do nothing, unsuccessfully",
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 20/34] doc: add documentation for 'exec' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/exec.c            |    5 +++++
 2 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 087ab4e..023a559 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -40,7 +40,7 @@ available in @a Barebox:
 @li @subpage edit_command
 @li @subpage erase_command
 @li @subpage ethact
-@li @subpage exec
+@li @subpage exec_command
 @li @subpage exit
 @li @subpage export_command
 @li @subpage false_command
diff --git a/commands/exec.c b/commands/exec.c
index 5f093b7..7f655b6 100644
--- a/commands/exec.c
+++ b/commands/exec.c
@@ -53,6 +53,11 @@ out:
 	return 1;
 }
 
+BAREBOX_CMD_HELP_START(exec)
+BAREBOX_CMD_HELP_USAGE("exec SCRIPT\n")
+BAREBOX_CMD_HELP_SHORT("Execute a script.\n")
+BAREBOX_CMD_HELP_END
+
 BAREBOX_CMD_START(exec)
 	.cmd		= do_exec,
 	.usage		= "execute a script",
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 21/34] doc: add documentation for 'reset' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/reset.c           |    5 +++++
 2 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 023a559..2d3d5f2 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -85,7 +85,7 @@ available in @a Barebox:
 @li @subpage protect_command
 @li @subpage pwd_command
 @li @subpage readline_command
-@li @subpage reset
+@li @subpage reset_command
 @li @subpage rarpboot
 @li @subpage reginfo
 @li @subpage rm_command
diff --git a/commands/reset.c b/commands/reset.c
index 46ab901..64c7f87 100644
--- a/commands/reset.c
+++ b/commands/reset.c
@@ -31,6 +31,11 @@ static int cmd_reset(struct command *cmdtp, int argc, char *argv[])
 	return 1;
 }
 
+BAREBOX_CMD_HELP_START(reset)
+BAREBOX_CMD_HELP_USAGE("reset\n")
+BAREBOX_CMD_HELP_SHORT("Perform a reset on the cpu.\n")
+BAREBOX_CMD_HELP_END
+
 BAREBOX_CMD_START(reset)
 	.cmd		= cmd_reset,
 	.usage		= "Perform RESET of the CPU",
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 22/34] doc: add documentation for 'reginfo' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/reginfo.c         |   12 ++++++++++++
 2 files changed, 13 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 2d3d5f2..c26abc2 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -87,7 +87,7 @@ available in @a Barebox:
 @li @subpage readline_command
 @li @subpage reset_command
 @li @subpage rarpboot
-@li @subpage reginfo
+@li @subpage reginfo_command
 @li @subpage rm_command
 @li @subpage rmdir_command
 @li @subpage saveenv_command
diff --git a/commands/reginfo.c b/commands/reginfo.c
index 90651d5..6e5be31 100644
--- a/commands/reginfo.c
+++ b/commands/reginfo.c
@@ -29,6 +29,18 @@ static int do_reginfo(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
+BAREBOX_CMD_HELP_START(reginfo)
+BAREBOX_CMD_HELP_USAGE("reginfo\n")
+BAREBOX_CMD_HELP_SHORT("Print register information.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page reginfo_command
+
+\todo Add more reginfo documentation.
+
+ */
+
 BAREBOX_CMD_START(reginfo)
 	.cmd		= do_reginfo,
 	.usage		= "print register information",
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 23/34] doc: add documentation for 'meminfo' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/meminfo.c         |    5 +++++
 2 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index c26abc2..907818e 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -68,7 +68,7 @@ available in @a Barebox:
 @li @subpage lsmod_command
 @li @subpage md
 @li @subpage memcmp
-@li @subpage meminfo
+@li @subpage meminfo_command
 @li @subpage memset
 @li @subpage menu
 @li @subpage mkdir_command
diff --git a/commands/meminfo.c b/commands/meminfo.c
index abbaf9c..176a636 100644
--- a/commands/meminfo.c
+++ b/commands/meminfo.c
@@ -30,6 +30,11 @@ static int do_meminfo(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
+BAREBOX_CMD_HELP_START(meminfo)
+BAREBOX_CMD_HELP_USAGE("meminfo\n")
+BAREBOX_CMD_HELP_SHORT("Print info about memory usage.\n")
+BAREBOX_CMD_HELP_END
+
 BAREBOX_CMD_START(meminfo)
 	.cmd		= do_meminfo,
 	.usage		= "print info about memory usage",
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 24/34] doc: add documentation for 'go' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/go.c              |   17 ++++++++++++-----
 2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 907818e..430cc52 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -49,7 +49,7 @@ available in @a Barebox:
 @li @subpage gpio_set_value_command
 @li @subpage gpio_direction_input_command
 @li @subpage gpio_direction_output_command
-@li @subpage go
+@li @subpage go_command
 @li @subpage help_command
 @li @subpage host
 @li @subpage i2c_probe
diff --git a/commands/go.c b/commands/go.c
index 0262940..cb0b72b 100644
--- a/commands/go.c
+++ b/commands/go.c
@@ -77,11 +77,18 @@ out:
 	return rcode;
 }
 
-static const __maybe_unused char cmd_go_help[] =
-"Usage: go addr [arg ...]\n"
-"Start application at address 'addr' passing 'arg' as arguments.\n"
-"If addr does not start with a digit it is interpreted as a filename\n"
-"in which case the file is memmapped and executed\n";
+BAREBOX_CMD_HELP_START(go)
+BAREBOX_CMD_HELP_USAGE("go ADDR [ARGS]\n")
+BAREBOX_CMD_HELP_SHORT("Start application at address ADDR, passing ARGS as arguments.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page go_command
+
+If ADDR does not start with a digit, it is interpreted as a filename. In
+this case the file is memory mapped and executed.
+
+ */
 
 BAREBOX_CMD_START(go)
 	.cmd		= do_go,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 25/34] doc: add documentation for 'source' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 common/hush.c              |   22 ++++++++++++----------
 2 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 430cc52..7f4e489 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -94,7 +94,7 @@ available in @a Barebox:
 @li @subpage setenv_command
 @li @subpage sh
 @li @subpage sleep_command
-@li @subpage source
+@li @subpage source_command
 @li @subpage test_command
 @li @subpage timeout_command
 @li @subpage true_command
diff --git a/common/hush.c b/common/hush.c
index 77610bb..4947173 100644
--- a/common/hush.c
+++ b/common/hush.c
@@ -1691,21 +1691,23 @@ static int do_source(struct command *cmdtp, int argc, char *argv[])
 
 static const char *source_aliases[] = { ".", NULL};
 
-static const __maybe_unused char cmd_source_help[] =
-"Usage: .  filename [arguments]\n"
-"or     source filename [arguments]\n"
-"\n"
-"Read  and  execute  commands  from filename in the current shell\n"
-"environment and return the exit status of the last command  exe-\n"
-"cuted from filename\n";
+BAREBOX_CMD_HELP_START(source)
+BAREBOX_CMD_HELP_USAGE(". FILE [ARGS], source FILE [ARGS]\n")
+BAREBOX_CMD_HELP_SHORT("Read and execute shell commands in the current shell.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page source_command
 
-static const __maybe_unused char cmd_source_usage[] =
-"execute shell script in current shell environment";
+The commands are executed in the current shell environment and return
+the exit status of the last command executed from FILE.
+
+ */
 
 BAREBOX_CMD_START(source)
 	.aliases	= source_aliases,
 	.cmd		= do_source,
-	.usage		= cmd_source_usage,
+	.usage		= "execute shell script in current shell environment"
 	BAREBOX_CMD_HELP(cmd_source_help)
 BAREBOX_CMD_END
 
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 26/34] doc: add documentation for 'sh' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 common/hush.c              |   15 ++++++++++-----
 2 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 7f4e489..438d33e 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -92,7 +92,7 @@ available in @a Barebox:
 @li @subpage rmdir_command
 @li @subpage saveenv_command
 @li @subpage setenv_command
-@li @subpage sh
+@li @subpage sh_command
 @li @subpage sleep_command
 @li @subpage source_command
 @li @subpage test_command
diff --git a/common/hush.c b/common/hush.c
index 4947173..e269836 100644
--- a/common/hush.c
+++ b/common/hush.c
@@ -1670,14 +1670,19 @@ static int do_sh(struct command *cmdtp, int argc, char *argv[])
 	return execute_script(argv[1], argc - 1, argv + 1);
 }
 
-static const __maybe_unused char cmd_sh_help[] =
-"Usage: sh filename [arguments]\n"
-"\n"
-"Execute a shell script\n";
+BAREBOX_CMD_HELP_START(sh)
+BAREBOX_CMD_HELP_USAGE("sh FILE [ARGS]\n")
+BAREBOX_CMD_HELP_SHORT("Execute a shell script.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page sh_command
+
+ */
 
 BAREBOX_CMD_START(sh)
 	.cmd		= do_sh,
-	.usage		= "run shell script",
+	.usage		= "execute a shell script",
 	BAREBOX_CMD_HELP(cmd_sh_help)
 BAREBOX_CMD_END
 
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 27/34] doc: add documentation for 'ping' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 net/ping.c                 |   16 ++++++++++++++++
 2 files changed, 17 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 438d33e..9638728 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -80,7 +80,7 @@ available in @a Barebox:
 @li @subpage nand_boot_test
 @li @subpage nfs
 @li @subpage passwd
-@li @subpage ping
+@li @subpage ping_command
 @li @subpage printenv_command
 @li @subpage protect_command
 @li @subpage pwd_command
diff --git a/net/ping.c b/net/ping.c
index d414784..c46a114 100644
--- a/net/ping.c
+++ b/net/ping.c
@@ -107,7 +107,23 @@ out:
 	return ping_state == PING_STATE_SUCCESS ? 0 : 1;
 }
 
+BAREBOX_CMD_HELP_START(ping)
+BAREBOX_CMD_HELP_USAGE("ping HOST\n")
+BAREBOX_CMD_HELP_SHORT("Send ICMP echo request to network host.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page ping_command
+
+<p> HOST can be an IP address or a host name. If a host name is
+specified, barebox tries to resolve that host name and exits with a
+failure if not successful. If the host didn't answer for 10 seconds,
+ping exits with a failure. </p>
+
+ */
+
 BAREBOX_CMD_START(ping)
 	.cmd		= do_ping,
 	.usage		= "ping <destination>",
+	BAREBOX_CMD_HELP(cmd_ping_help)
 BAREBOX_CMD_END
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 28/34] doc: add documentation for 'nfs' command

[Robert Schwebel]

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

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 9638728..8895e0e 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -78,7 +78,7 @@ available in @a Barebox:
 @li @subpage mycdev
 @li @subpage nand
 @li @subpage nand_boot_test
-@li @subpage nfs
+@li @subpage nfs_command
 @li @subpage passwd
 @li @subpage ping_command
 @li @subpage printenv_command
diff --git a/net/nfs.c b/net/nfs.c
index 4ca1d6e..d8e0bcc 100644
--- a/net/nfs.c
+++ b/net/nfs.c
@@ -725,9 +725,17 @@ err_udp:
 	return nfs_err == 0 ? 0 : 1;
 }
 
-static const __maybe_unused char cmd_nfs_help[] =
-"Usage: nfs <file> [localfile]\n"
-"Load a file via network using nfs protocol.\n";
+BAREBOX_CMD_HELP_START(nfs)
+BAREBOX_CMD_HELP_USAGE("nfs FILE [LOCALFILE]\n")
+BAREBOX_CMD_HELP_SHORT("Load a file via network, using the NFS protocol.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page nfs_command
+
+\todo Add more details and examples.
+
+ */
 
 BAREBOX_CMD_START(nfs)
 	.cmd		= do_nfs,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 29/34] doc: add documentation for 'rarpboot' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 Doxyfile                   |    3 ++-
 commands/net.c             |   19 ++++++++++++++++---
 3 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 8895e0e..7a515c5 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -86,7 +86,7 @@ available in @a Barebox:
 @li @subpage pwd_command
 @li @subpage readline_command
 @li @subpage reset_command
-@li @subpage rarpboot
+@li @subpage rarpboot_command
 @li @subpage reginfo_command
 @li @subpage rm_command
 @li @subpage rmdir_command
diff --git a/Doxyfile b/Doxyfile
index 89151e3..73dbb6d 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -1070,7 +1070,8 @@ INCLUDE_FILE_PATTERNS  =
 PREDEFINED             = \
 			DOXYGEN_SHOULD_SKIP_THIS \
 			CONFIG_CMD_DEVINFO \
-			CONFIG_NET_TFTP_PUSH
+			CONFIG_NET_TFTP_PUSH \
+			CONFIG_NET_RARP
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.
diff --git a/commands/net.c b/commands/net.c
index 938463c..3adf537 100644
--- a/commands/net.c
+++ b/commands/net.c
@@ -38,7 +38,7 @@
 #ifdef CONFIG_NET_RARP
 extern void RarpRequest(void);
 
-static int do_rarpb(struct command *cmdtp, int argc, char *argv[])
+static int do_rarpboot(struct command *cmdtp, int argc, char *argv[])
 {
 	int size;
 
@@ -57,11 +57,24 @@ static int do_rarpb(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
+BAREBOX_CMD_HELP_START(rarpboot)
+BAREBOX_CMD_HELP_USAGE("rarpboot [LOADADDR] [BOOTFILENAME]\n")
+BAREBOX_CMD_HELP_SHORT("Boot an image via network using rarp/tftp protocol.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page rarpboot_command
+
+\todo Discuss this command with sha. The signature looks wrong.
+
+ */
+
 BAREBOX_CMD_START(rarpboot)
-	.cmd		= do_rarpb,
+	.cmd		= do_rarpboot,
 	.usage		= "boot image via network using rarp/tftp protocol",
-	BAREBOX_CMD_HELP("[loadAddress] [bootfilename]\n")
+	BAREBOX_CMD_HELP(cmd_rarpboot_help)
 BAREBOX_CMD_END
+
 #endif /* CONFIG_NET_RARP */
 
 static int do_ethact(struct command *cmdtp, int argc, char *argv[])
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 30/34] doc: add documentation for 'passwd' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/passwd.c          |   18 +++++++++++++-----
 2 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 7a515c5..44a72da 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -79,7 +79,7 @@ available in @a Barebox:
 @li @subpage nand
 @li @subpage nand_boot_test
 @li @subpage nfs_command
-@li @subpage passwd
+@li @subpage passwd_command
 @li @subpage ping_command
 @li @subpage printenv_command
 @li @subpage protect_command
diff --git a/commands/passwd.c b/commands/passwd.c
index 9435091..092d7e9 100644
--- a/commands/passwd.c
+++ b/commands/passwd.c
@@ -85,11 +85,19 @@ disable:
 	return ret;
 }
 
-static const __maybe_unused char cmd_passwd_help[] =
-"Usage: passwd\n"
-"passwd allow you to specify a password\n"
-"to disable it put an empty password\n"
-;
+BAREBOX_CMD_HELP_START(passwd)
+BAREBOX_CMD_HELP_USAGE("passwd\n")
+BAREBOX_CMD_HELP_SHORT("Allows you to specify a password.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page passwd_command
+
+To disable the password, specify an empty one.
+
+\todo Add an example.
+
+ */
 
 BAREBOX_CMD_START(passwd)
 	.cmd		= do_passwd,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 31/34] doc: add documentation for 'nand' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/nand.c            |   22 +++++++++++++++-------
 2 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 44a72da..881fc2c 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -76,7 +76,7 @@ available in @a Barebox:
 @li @subpage mtest
 @li @subpage mw
 @li @subpage mycdev
-@li @subpage nand
+@li @subpage nand_command
 @li @subpage nand_boot_test
 @li @subpage nfs_command
 @li @subpage passwd_command
diff --git a/commands/nand.c b/commands/nand.c
index 0902f21..18c6bd3 100644
--- a/commands/nand.c
+++ b/commands/nand.c
@@ -354,15 +354,23 @@ static int do_nand(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_nand_help[] =
-"Usage: nand [OPTION]...\n"
-"nand related commands\n"
-"  -a  <dev>  register a bad block aware device ontop of a normal nand device\n"
-"  -d  <dev>  deregister a bad block aware device\n"
-"  -b  <ofs> <dev> mark block at offset ofs as bad\n";
+BAREBOX_CMD_HELP_START(nand)
+BAREBOX_CMD_HELP_USAGE("nand [OPTIONS]\n")
+BAREBOX_CMD_HELP_SHORT("NAND related commands.\n")
+BAREBOX_CMD_HELP_OPT  ("-a <dev>", "register a bad block aware device ontop of a normal nand device\n")
+BAREBOX_CMD_HELP_OPT  ("-d <dev>", "deregister a bad block aware device\n")
+BAREBOX_CMD_HELP_OPT  ("-b <ofs> <dev>", "mark block at offset ofs as bad\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page nand_command
+
+\todo This does definitely need more documentation.
+
+ */
 
 BAREBOX_CMD_START(nand)
 	.cmd		= do_nand,
-	.usage		= "NAND specific handling",
+	.usage		= "NAND related commands",
 	BAREBOX_CMD_HELP(cmd_nand_help)
 BAREBOX_CMD_END
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 32/34] doc: add documentation for 'mw' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/mem.c             |   20 ++++++++++++++------
 2 files changed, 15 insertions(+), 7 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 881fc2c..c9a786d 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -74,7 +74,7 @@ available in @a Barebox:
 @li @subpage mkdir_command
 @li @subpage mount_command
 @li @subpage mtest
-@li @subpage mw
+@li @subpage mw_command
 @li @subpage mycdev
 @li @subpage nand_command
 @li @subpage nand_boot_test
diff --git a/commands/mem.c b/commands/mem.c
index 73bf915..dc778d3 100644
--- a/commands/mem.c
+++ b/commands/mem.c
@@ -289,12 +289,20 @@ static int do_mem_mw(struct command *cmdtp, int argc, char *argv[])
 	return errno;
 }
 
-static const __maybe_unused char cmd_mw_help[] =
-"Usage: mw [OPTIONS] <region> <value(s)>\n"
-"Write value(s) to the specifies region.\n"
-"options:\n"
-"  -b, -w, -l	use byte, halfword, or word accesses\n"
-"  -d <file>	write file (default /dev/mem)\n";
+BAREBOX_CMD_HELP_START(mw)
+BAREBOX_CMD_HELP_USAGE("mw [OPTIONS] REGION VALUE(s)\n")
+BAREBOX_CMD_HELP_SHORT("Write value(s) to the specified region.\n")
+BAREBOX_CMD_HELP_OPT  ("-b, -w, -l", "use byte, halfword or word accesses\n")
+BAREBOX_CMD_HELP_OPT  ("-d <file>", "write file (default: /dev/mem)\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page mw_command
+
+\todo Add more documentation, especially an example and more info about <region>
+
+ */
+
 
 BAREBOX_CMD_START(mw)
 	.cmd		= do_mem_mw,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 33/34] doc: add documentation for 'memcmp' command

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/mem.c             |   33 +++++++++++++++++++--------------
 2 files changed, 20 insertions(+), 15 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index c9a786d..7f5c4f7 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -67,7 +67,7 @@ available in @a Barebox:
 @li @subpage ls_command
 @li @subpage lsmod_command
 @li @subpage md
-@li @subpage memcmp
+@li @subpage memcmp_command
 @li @subpage meminfo_command
 @li @subpage memset
 @li @subpage menu
diff --git a/commands/mem.c b/commands/mem.c
index dc778d3..f9f71a7 100644
--- a/commands/mem.c
+++ b/commands/mem.c
@@ -310,7 +310,7 @@ BAREBOX_CMD_START(mw)
 	BAREBOX_CMD_HELP(cmd_mw_help)
 BAREBOX_CMD_END
 
-static int do_mem_cmp(struct command *cmdtp, int argc, char *argv[])
+static int do_memcmp(struct command *cmdtp, int argc, char *argv[])
 {
 	ulong	addr1, addr2, count = ~0;
 	int	mode  = O_RWSIZE_1;
@@ -400,21 +400,26 @@ out:
 	return ret;
 }
 
-static const __maybe_unused char cmd_memcmp_help[] =
-"Usage: memcmp [OPTIONS] <addr1> <addr2> <count>\n"
-"\n"
-"options:\n"
-"  -b, -w, -l	use byte, halfword, or word accesses\n"
-"  -s <file>    source file (default /dev/mem)\n"
-"  -d <file>    destination file (default /dev/mem)\n"
-"\n"
-"Compare memory regions specified with addr1 and addr2\n"
-"of size <count> bytes. If source is a file count can\n"
-"be left unspecified in which case the whole file is\n"
-"compared\n";
+BAREBOX_CMD_HELP_START(memcmp)
+BAREBOX_CMD_HELP_USAGE("memcmp [OPTIONS] ADDR1 ADDR2 COUNT\n")
+BAREBOX_CMD_HELP_SHORT("Compare memory regions ADDR1 and ADDR2 of COUNT bytes.\n")
+BAREBOX_CMD_HELP_OPT  ("-b, -w, -l", "use byte, halfword or word accesses\n")
+BAREBOX_CMD_HELP_OPT  ("-s <file>", "source file (default: /dev/mem)\n")
+BAREBOX_CMD_HELP_OPT  ("-d <file>", "destination file (default: /dev/mem)\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page memcmp_command
+
+<p> If source is a file, count can be left unspecified. In this case the
+whole file is compared.</p>
+
+\todo Add example.
+
+ */
 
 BAREBOX_CMD_START(memcmp)
-	.cmd		= do_mem_cmp,
+	.cmd		= do_memcmp,
 	.usage		= "memory compare",
 	BAREBOX_CMD_HELP(cmd_memcmp_help)
 BAREBOX_CMD_END
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

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

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    2 +-
 commands/mem.c             |   37 ++++++++++++++++++++-----------------
 2 files changed, 21 insertions(+), 18 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 7f5c4f7..1148e3d 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -66,7 +66,7 @@ available in @a Barebox:
 @li @subpage login
 @li @subpage ls_command
 @li @subpage lsmod_command
-@li @subpage md
+@li @subpage md_command
 @li @subpage memcmp_command
 @li @subpage meminfo_command
 @li @subpage memset
diff --git a/commands/mem.c b/commands/mem.c
index f9f71a7..76bfa0a 100644
--- a/commands/mem.c
+++ b/commands/mem.c
@@ -212,24 +212,27 @@ out:
 	return errno;
 }
 
-static const __maybe_unused char cmd_md_help[] =
-"Usage md [OPTIONS] <region>\n"
-"display (hexdump) a memory region.\n"
-"options:\n"
-"  -s <file>   display file (default /dev/mem)\n"
-"  -b          output in bytes\n"
-"  -w          output in halfwords (16bit)\n"
-"  -l          output in words (32bit)\n"
-"\n"
-"Memory regions:\n"
-"Memory regions can be specified in two different forms: start+size\n"
-"or start-end, If <start> is ommitted it defaults to 0. If end is ommited it\n"
-"defaults to the end of the device, except for interactive commands like md\n"
-"and mw for which it defaults to 0x100.\n"
-"Sizes can be specified as decimal, or if prefixed with 0x as hexadecimal.\n"
-"an optional suffix of k, M or G is for kibibytes, Megabytes or Gigabytes,\n"
-"respectively\n";
 
+BAREBOX_CMD_HELP_START(md)
+BAREBOX_CMD_HELP_USAGE("md [OPTIONS] <region>\n")
+BAREBOX_CMD_HELP_SHORT("Display (hexdump) a memory region.\n")
+BAREBOX_CMD_HELP_OPT  ("-s <file>", "display file (default: /dev/mem)\n")
+BAREBOX_CMD_HELP_OPT  ("-b", "output in bytes\n")
+BAREBOX_CMD_HELP_OPT  ("-w", "output in halfwords (16 bit)\n")
+BAREBOX_CMD_HELP_OPT  ("-l", "output in words (32 bit)\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page md_command
+
+<p> Memory regions can be specified in two different forms: start+size
+or start-end, If <start> is ommitted it defaults to 0. If end is ommited
+it defaults to the end of the device, except for interactive commands
+like md and mw for which it defaults to 0x100. Sizes can be specified as
+decimal, or if prefixed with 0x as hexadecimal. an optional suffix of k,
+M or G is for kibibytes, Megabytes or Gigabytes, respectively. </p>
+
+ */
 
 BAREBOX_CMD_START(md)
 	.cmd		= do_mem_md,
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

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

[Sascha Hauer]

On Wed, Dec 15, 2010 at 12:51:17PM +0100, Robert Schwebel wrote:
> Signed-off-by: Robert Schwebel <r.schwebel@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
> -@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 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.

That's simple: unlzo <src> <target>, where src and target are valid files
including devices or partitions.

Sascha


-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox