diff options
| author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-11-01 18:17:42 +0100 |
|---|---|---|
| committer | Sascha Hauer <s.hauer@pengutronix.de> | 2010-11-02 17:55:17 +0100 |
| commit | edfe5e84295f6a568771a8a97f50b30eccbb27cd (patch) | |
| tree | 2dbecfcabe0707c5e2023f3d2086ef3e642ca812 | |
| parent | c5b0f1f0a35c9c30df7ded5b79d117bfde0d1c94 (diff) | |
| download | barebox-edfe5e84295f6a568771a8a97f50b30eccbb27cd.tar.gz barebox-edfe5e84295f6a568771a8a97f50b30eccbb27cd.tar.xz | |
doc: unify documentation for 'linux16'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
| -rw-r--r-- | commands/linux16.c | 25 |
1 files changed, 12 insertions, 13 deletions
diff --git a/commands/linux16.c b/commands/linux16.c index b15812f1d9..ec859a73ab 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. |