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 10/13] doc: unify documentation for 'linux16'
Date: Tue,  2 Nov 2010 14:10:39 +0100	[thread overview]
Message-ID: <1288703442-5032-11-git-send-email-r.schwebel@pengutronix.de> (raw)
In-Reply-To: <1288703442-5032-1-git-send-email-r.schwebel@pengutronix.de>

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

diff --git a/commands/linux16.c b/commands/linux16.c
index b15812f..ec859a7 100644
--- a/commands/linux16.c
+++ b/commands/linux16.c
@@ -288,14 +288,22 @@ on_error:
 	return rc;
 }
 
-static const __maybe_unused char cmd_linux16_help[] =
-"Usage: linux16 <file>\n"
-"Boot a linux kernel via real mode code\n";
+BAREBOX_CMD_HELP_START(linux16)
+BAREBOX_CMD_HELP_USAGE("linux16 <file>\n")
+BAREBOX_CMD_HELP_SHORT("Boot a kernel on x86 via real mode code.\n")
+BAREBOX_CMD_HELP_END
 
+/**
+ * @page linux16_command
+
+<p> Only kernel images in bzImage format are supported by now. See \ref
+x86_boot_preparation for more info about how to use this command.</p>
+
+ */
 
 BAREBOX_CMD_START(linux16)
 	.cmd		= do_linux16,
-	.usage		= "boot linux kernel",
+	.usage		= "boot a linux kernel",
 	BAREBOX_CMD_HELP(cmd_linux16_help)
 BAREBOX_CMD_END
 
@@ -305,15 +313,6 @@ BAREBOX_CMD_END
  */
 
 /**
- * @page linux16_command linux16: Boot a bzImage kernel on x86
- *
- * Usage is: linux16 \<file\>
- *
- * Boot a linux kernel via real mode code. Only kernel images in the
- * @p bzImage format are supported.
- */
-
-/**
  * @page x86_boot_preparation Linux Preparation on x86
  *
  * Due to some real mode constraints, starting Linux is somehow tricky.
-- 
1.7.2.3


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

  parent reply	other threads:[~2010-11-02 13:10 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-11-02 13:10 documentation updates Robert Schwebel
2010-11-02 13:10 ` [PATCH 01/13] doc: remove obsolete link method for arch specification Robert Schwebel
2010-11-02 13:10 ` [PATCH 02/13] doc: unify documentation for 'loadenv' Robert Schwebel
2010-11-02 13:10 ` [PATCH 03/13] doc: remove ..., confuses doxygen Robert Schwebel
2010-11-02 13:10 ` [PATCH 04/13] doc: unify documentation for 'mount' Robert Schwebel
2010-11-02 13:10 ` [PATCH 05/13] doc: unify documentation for 'printenv' Robert Schwebel
2010-11-02 13:10 ` [PATCH 06/13] doc: unify documentation for 'protect' and 'unprotect' Robert Schwebel
2010-11-02 13:10 ` [PATCH 07/13] doc: unify documentation for 'saveenv' Robert Schwebel
2010-11-02 13:10 ` [PATCH 08/13] doc: unify documentation for 'setenv' Robert Schwebel
2010-11-02 13:10 ` [PATCH 09/13] doc: remove sh from command documentation Robert Schwebel
2010-11-02 13:10 ` Robert Schwebel [this message]
2010-11-02 13:10 ` [PATCH 11/13] doc: put CPUIMX35 into the right chapter Robert Schwebel
2010-11-02 13:10 ` [PATCH 12/13] doc: put babage board " Robert Schwebel
2010-11-02 13:10 ` [PATCH 13/13] doc: put cupid " 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=1288703442-5032-11-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