sysmo-bts
/
barebox
9
0
Fork 0
Code Releases Activity

doc: add documentation for 'bootm' 

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
This commit is contained in:
Robert Schwebel 2010-10-17 18:18:37 +02:00 committed by Sascha Hauer
parent 7f89e29fac
commit 5a1286d696
2 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/commands.dox
View File

@ -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

38
commands/bootm.c
View File

@ -368,19 +368,25 @@ 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)\n")
BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(bootm)
.cmd = do_bootm,
.usage = "boot application image",
.usage = "boot an application image",
BAREBOX_CMD_HELP(cmd_bootm_help)
BAREBOX_CMD_END
/**
* @page bootm_command
\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 +446,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\n")
BAREBOX_CMD_HELP_SHORT("Print header information for an application image.\n")
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 */