[PATCH 10/13] doc: unify documentation for 'linux16'
Robert Schwebel
r.schwebel at pengutronix.de
Tue Nov 2 09:10:39 EDT 2010
Signed-off-by: Robert Schwebel <r.schwebel at 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
More information about the barebox
mailing list