[flashrom] [PATCH] flashrom.8: improve dummy programmer documentation

Uwe Hermann uwe at hermann-uwe.de
Sun Jul 24 14:45:34 CEST 2011


On Sun, Jul 24, 2011 at 01:21:42AM +0200, Carl-Daniel Hailfinger wrote:
> +The dummy programmer operates on a buffer in memory only. It provides a safe and
> +fast way to test various aspects of flashrom and is mainly used in development
> +and while debugging.

Minor issue, but the "and" could be in the next line, it ends exactly on
column 80, which makes the line look a bit "crowded" IMHO (the
"development" has to go into the next line too, then).


> +.sp
> +It is able to emulate some chips to a certain degree (basic identify/read/write
> +operations work).

Erase does not work? If so, we should probably implement that too.


> +If you use SPI flash chip emulation for a chip which supports SPI page write
> +with the default opcode, you can set the maximum allowed write chunk size with
> +the
> +.sp
> +.B "  flashrom \-p dummy:emulate=chip,spi_write_256_chunksize=size"
> +.sp
> +syntax where
> +.B size
> +is the number of bytes (min. 1, max. 256).
> +.sp
> +Example:
> +.B "flashrom -p dummy:emulate=M25P10.RES,spi_write_256_chunksize=5"

Please add an ".sp" after the "Example:" line, and indent the CLI
invocation by 2 spaces as above, otherwise the line is too long when
viewed using "man flashrom" and is wrapped automatically in a very ugly
way. Using the ".sp" and two spaces it looks OK.


> +.BR internal ", " nic3com ", " nicrealtek ", " nicsmc1211 ", " nicnatsemi ", "
> +.BR gfxnvidia" ", " drkaiser ", " satasii ", " satamv " and " atahpt
                ^
  This character has to be killed, looks incorrect in the output otherwise.


With the above changes:
Acked-by: Uwe Hermann <uwe at hermann-uwe.de>


Uwe.
-- 
http://hermann-uwe.de     | http://sigrok.org
http://randomprojects.org | http://unmaintained-free-software.org




More information about the flashrom mailing list