1
0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-27 15:12:36 +02:00

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.

BUG=b:224364316

Change-Id: I0cba593da3926c8587027789f4e1e89a2329ca7f
Signed-off-by: Daniel Campello <campello@chromium.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/62794
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Edward O'Callaghan <quasisec@chromium.org>
This commit is contained in:
Daniel Campello 2022-03-14 11:43:16 -06:00 committed by Edward O'Callaghan
parent caa0335114
commit 025c75d05c
2 changed files with 13 additions and 7 deletions

View File

@ -47,9 +47,9 @@ static void cli_classic_usage(const char *name)
printf(" -h | --help print this help text\n" printf(" -h | --help print this help text\n"
" -R | --version print version (release)\n" " -R | --version print version (release)\n"
" -r | --read <file> read flash and save to <file>\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" " 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" " or the content provided on the standard input\n"
" -E | --erase erase flash memory\n" " -E | --erase erase flash memory\n"
" -V | --verbose more verbose output\n" " -V | --verbose more verbose output\n"

View File

@ -82,11 +82,13 @@ Read flash ROM contents and save them into the given
.BR <file> . .BR <file> .
If the file already exists, it will be overwritten. If the file already exists, it will be overwritten.
.TP .TP
.B "\-w, \-\-write <file>" .B "\-w, \-\-write (<file>|-)"
Write Write
.B <file> .B <file>
into flash ROM. This will first automatically into flash ROM. If
.B erase .B -
is provided instead, contents will be read from stdin. This will first automatically
B erase
the chip, then write to it. the chip, then write to it.
.sp .sp
In the process the chip is also read several times. First an in-memory backup In the process the chip is also read several times. First an in-memory backup
@ -124,16 +126,20 @@ region using the
.BR internal .BR internal
programmer. It may be enabled by default in this case in the future. programmer. It may be enabled by default in this case in the future.
.TP .TP
.B "\-v, \-\-verify <file>" .B "\-v, \-\-verify (<file>|-)"
Verify the flash ROM contents against the given Verify the flash ROM contents against the given
.BR <file> . .BR <file> .
If
.BR -
is provided instead, contents will be written to the stdout.
.TP .TP
.B "\-E, \-\-erase" .B "\-E, \-\-erase"
Erase the flash ROM chip. Erase the flash ROM chip.
.TP .TP
.B "\-x, \-\-extract" .B "\-x, \-\-extract"
Extract every region defined on the layout from flash ROM chip to a Extract every region defined on the layout from flash ROM chip to a
file with the same name as the extracted region. file with the same name as the extracted region (replacing spaces with
underscores).
.TP .TP
.B "\-V, \-\-verbose" .B "\-V, \-\-verbose"
More verbose output. This option can be supplied multiple times More verbose output. This option can be supplied multiple times