Documentation: revamp dfu's help text
... so that it looks a bit nicer in the HTML generated docs. Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
This commit is contained in:
parent
2f0f5522a8
commit
7ac222cbad
|
@ -172,12 +172,15 @@ out:
|
|||
|
||||
BAREBOX_CMD_HELP_START(dfu)
|
||||
BAREBOX_CMD_HELP_TEXT("Turn's the USB host into DFU mode (Device Firmware Mode) and accepts")
|
||||
BAREBOX_CMD_HELP_TEXT("a new firmware. The destination is described by DESC in the this format:")
|
||||
BAREBOX_CMD_HELP_TEXT(" DEVICE(NAME)[src]...")
|
||||
BAREBOX_CMD_HELP_TEXT("Specify the '(') and ')' literal, the [] however denote this optional modes:")
|
||||
BAREBOX_CMD_HELP_TEXT("- 's' safe mode (download the complete image before flashing)")
|
||||
BAREBOX_CMD_HELP_TEXT("- 'r' readback of the firmware is allowed")
|
||||
BAREBOX_CMD_HELP_TEXT("- 'c' the file will be created (for use with regular files)")
|
||||
BAREBOX_CMD_HELP_TEXT("a new firmware. The destination is described by DESC in the format")
|
||||
BAREBOX_CMD_HELP_TEXT("")
|
||||
BAREBOX_CMD_HELP_TEXT("\tDEVICE(NAME)[src]...")
|
||||
BAREBOX_CMD_HELP_TEXT("")
|
||||
BAREBOX_CMD_HELP_TEXT("Here '(' and ')' are literal characters. The '[' and ']' however denote")
|
||||
BAREBOX_CMD_HELP_TEXT("one of the following optional modes:")
|
||||
BAREBOX_CMD_HELP_TEXT("'s': safe mode (download the complete image before flashing); ")
|
||||
BAREBOX_CMD_HELP_TEXT("'r': readback of the firmware is allowed; ")
|
||||
BAREBOX_CMD_HELP_TEXT("'c': the file will be created (for use with regular files).")
|
||||
BAREBOX_CMD_HELP_TEXT("")
|
||||
BAREBOX_CMD_HELP_TEXT("Options:")
|
||||
BAREBOX_CMD_HELP_OPT ("-m STR", "Manufacturer string (barebox)")
|
||||
|
|
Loading…
Reference in New Issue