diff options
| author | Holger Schurig <holgerschurig@gmail.com> | 2014-07-22 09:56:49 +0200 |
|---|---|---|
| committer | Sascha Hauer <s.hauer@pengutronix.de> | 2014-07-22 21:16:06 +0200 |
| commit | 7ac222cbadb8ef10413bed8ac4a16fff636f0c3f (patch) | |
| tree | c29642628584c9f9a0f9e880359c2cb5cdb8b743 | |
| parent | 2f0f5522a8c21e8ded9eefae2691e174d713f6b4 (diff) | |
| download | barebox-7ac222cbadb8ef10413bed8ac4a16fff636f0c3f.tar.gz barebox-7ac222cbadb8ef10413bed8ac4a16fff636f0c3f.tar.xz | |
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>
| -rw-r--r-- | commands/dfu.c | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/commands/dfu.c b/commands/dfu.c index 354625260d..7f78f3bbc2 100644 --- a/commands/dfu.c +++ b/commands/dfu.c @@ -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)") |