flashrom.8.tmpl: Clarify man entries for -w/-v/-x
This change adds follow up changes to the man page:
- Explain (-) argument for -w/-v operations
- Expand on region name handling of -x operation
Also updates cli_classic.c to match with --help output.
flashrom-stable:
* Fixed -v description (reads from stdin)
* s/ B/.B/
Change-Id: I0cba593da3926c8587027789f4e1e89a2329ca7f
Signed-off-by: Daniel Campello <campello@chromium.org>
Original-Reviewed-on: https://review.coreboot.org/c/flashrom/+/62794
Original-Reviewed-by: Edward O'Callaghan <quasisec@chromium.org>
Reviewed-on: https://review.coreboot.org/c/flashrom-stable/+/71556
Reviewed-by: Nico Huber <nico.h@gmx.de>
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
diff --git a/cli_classic.c b/cli_classic.c
index be2f86c..7f6887c 100644
--- a/cli_classic.c
+++ b/cli_classic.c
@@ -45,9 +45,9 @@
printf(" -h | --help print this help text\n"
" -R | --version print version (release)\n"
" -r | --read <file> read flash and save to <file>\n"
- " -w | --write <file|-> write <file> or the content provided\n"
+ " -w | --write (<file>|-) write <file> or the content provided\n"
" on the standard input to flash\n"
- " -v | --verify <file|-> verify flash against <file>\n"
+ " -v | --verify (<file>|-) verify flash against <file>\n"
" or the content provided on the standard input\n"
" -E | --erase erase flash memory\n"
" -V | --verbose more verbose output\n"
diff --git a/flashrom.8.tmpl b/flashrom.8.tmpl
index cb56939..e830d87 100644
--- a/flashrom.8.tmpl
+++ b/flashrom.8.tmpl
@@ -86,10 +86,12 @@
.BR <file> .
If the file already exists, it will be overwritten.
.TP
-.B "\-w, \-\-write <file>"
+.B "\-w, \-\-write (<file>|-)"
Write
.B <file>
-into flash ROM. This will first automatically
+into flash ROM. If
+.B -
+is provided instead, contents will be read from stdin. This will first automatically
.B erase
the chip, then write to it.
.sp
@@ -128,9 +130,12 @@
.BR internal
programmer. It may be enabled by default in this case in the future.
.TP
-.B "\-v, \-\-verify <file>"
+.B "\-v, \-\-verify (<file>|-)"
Verify the flash ROM contents against the given
.BR <file> .
+If
+.BR -
+is provided instead, contents will be read from stdin.
.TP
.B "\-E, \-\-erase"
Erase the flash ROM chip.