mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Robert Schwebel <r.schwebel@pengutronix.de>
To: barebox@lists.infradead.org
Subject: [PATCH 12/21] doc: add documentation for 'bootm'
Date: Mon,  1 Nov 2010 09:33:45 +0100	[thread overview]
Message-ID: <1288600434-6112-13-git-send-email-r.schwebel@pengutronix.de> (raw)
In-Reply-To: <1288600434-6112-1-git-send-email-r.schwebel@pengutronix.de>

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

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 38968b5..2679ed7 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -3,6 +3,7 @@
 
 @li @subpage addpart_command
 @li @subpage bmp_command
+@li @subpage bootm_command
 @li @subpage cat_command
 @li @subpage cd_command
 @li @subpage clear_command
diff --git a/commands/bootm.c b/commands/bootm.c
index 0d3649f..eab23d9 100644
--- a/commands/bootm.c
+++ b/commands/bootm.c
@@ -368,18 +368,18 @@ err_out:
 	return 1;
 }
 
-static const __maybe_unused char cmd_bootm_help[] =
-"Usage: bootm [OPTION] image\n"
-"Boot application image\n"
-" -n             do not verify the images (speeds up boot process)\n"
-" -h             show advanced options\n";
+BAREBOX_CMD_HELP_START(bootm)
+BAREBOX_CMD_HELP_USAGE("bootm [-n] image\n")
+BAREBOX_CMD_HELP_SHORT("Boot an application image.\n")
+BAREBOX_CMD_HELP_OPT  ("-n",  "Do not verify the image (speeds up boot process)")
+BAREBOX_CMD_HELP_END
 
+/**
+ * @page bootm_command
 
-BAREBOX_CMD_START(bootm)
-	.cmd		= do_bootm,
-	.usage		= "boot application image",
-	BAREBOX_CMD_HELP(cmd_bootm_help)
-BAREBOX_CMD_END
+\todo What does bootm do, what kind of image does it boot?
+
+ */
 
 #ifdef CONFIG_CMD_IMI
 static int do_iminfo(struct command *cmdtp, int argc, char *argv[])
@@ -440,14 +440,16 @@ static int image_info (ulong addr)
 	return 0;
 }
 
-BAREBOX_CMD(
-	iminfo,		1,	do_iminfo,
-	"iminfo  - print header information for application image\n",
-	"addr [addr ...]\n"
-	"    - print header information for application image starting at\n"
-	"      address 'addr' in memory; this includes verification of the\n"
-	"      image contents (magic number, header and payload checksums)\n"
-);
+BAREBOX_CMD_HELP_START(iminfo)
+BAREBOX_CMD_HELP_USAGE("iminfo")
+BAREBOX_CMD_HELP_SHORT("Print header information for an application image.")
+BAREBOX_CMD_HELP_END
+
+BAREBOX_CMD_START(iminfo)
+	.cmd		= do_iminfo,
+	.usage		= "print header information for an application image",
+	BAREBOX_CMD_HELP(cmd_iminfo_help)
+BAREBOX_CMD_END
 
 #endif	/* CONFIG_CMD_IMI */
 
-- 
1.7.2.3


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

  parent reply	other threads:[~2010-11-01  8:34 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-11-01  8:33 Unified Documentation Robert Schwebel
2010-11-01  8:33 ` [PATCH 01/21] doc: fix typo Robert Schwebel
2010-11-01  8:33 ` [PATCH 02/21] doc: add macros to unify command help with doxygen Robert Schwebel
2010-11-01  8:33 ` [PATCH 03/21] doc: add documentation for 'bmp' Robert Schwebel
2010-11-01  8:33 ` [PATCH 04/21] doc: add documentation for 'clear' Robert Schwebel
2010-11-01  8:33 ` [PATCH 05/21] doc: add documentation for 'crc32' Robert Schwebel
2010-11-01  8:33 ` [PATCH 06/21] doc: add documentation for 'dfu' Robert Schwebel
2010-11-01  8:51   ` Baruch Siach
2010-11-01 10:03     ` Robert Schwebel
2010-11-01  8:33 ` [PATCH 07/21] doc: unify documentation for 'ls' Robert Schwebel
2010-11-01  8:33 ` [PATCH 08/21] doc: unify documentation for 'cat' Robert Schwebel
2010-11-01  8:33 ` [PATCH 09/21] doc: unify documentation for 'cd' Robert Schwebel
2010-11-01  8:33 ` [PATCH 10/21] doc: add documentation for 'echo' Robert Schwebel
2010-11-01  8:33 ` [PATCH 11/21] doc: unify documentation for 'edit' Robert Schwebel
2010-11-01  8:33 ` Robert Schwebel [this message]
2010-11-01  8:33 ` [PATCH 13/21] doc: unify documentation for 'addpart' Robert Schwebel
2010-11-01  8:33 ` [PATCH 14/21] doc: unify documentation for 'cp' Robert Schwebel
2010-11-01  8:33 ` [PATCH 15/21] doc: unify documentation for 'delpart' Robert Schwebel
2010-11-01  8:33 ` [PATCH 16/21] doc: rework user manual Robert Schwebel
2010-11-01  8:33 ` [PATCH 17/21] doc: unify documentation for 'devinfo' Robert Schwebel
2010-11-01  8:33 ` [PATCH 18/21] doc: unify documentation for 'erase' Robert Schwebel
2010-11-01  8:33 ` [PATCH 19/21] doc: rework and unify documentation for gpio commands Robert Schwebel
2010-11-01  8:33 ` [PATCH 20/21] doc: unify documentation for 'export' Robert Schwebel
2010-11-01  8:33 ` [PATCH 21/21] doc: unify documentation for 'tftp' Robert Schwebel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1288600434-6112-13-git-send-email-r.schwebel@pengutronix.de \
    --to=r.schwebel@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox