[flashrom] [PATCH] flashrom.8: improve dummy programmer documentation
c-d.hailfinger.devel.2006 at gmx.net
Sun Jul 24 20:42:11 CEST 2011
Am 24.07.2011 14:45 schrieb Uwe Hermann:
> 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).
It is reformatted before being displayed in the man page anyway, but
sure, I can use an 79 column limit.
>> +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.
Erase works, I just thought that was implied in write (the man page is
end-user documentation after all). Will change.
>> +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
>> +.B " flashrom \-p dummy:emulate=chip,spi_write_256_chunksize=size"
>> +syntax where
>> +.B size
>> +is the number of bytes (min. 1, max. 256).
>> +.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.
I had that, but the look was inconsistent. That said, the linebreak is
worse, so I'll change it.
Should we move all examples to an example section in the man page?
>> +.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.
Thanks, I didn't spot that one.
> With the above changes:
> Acked-by: Uwe Hermann <uwe at hermann-uwe.de>
Thanks, committed with changes in r1383.
More information about the flashrom