Patchwork Random manpage improvements and updates

login
register
about
Submitter Uwe Hermann
Date 2011-07-24 13:17:54
Message ID <20110724131754.GN4802@greenwood>
Download mbox | patch
Permalink /patch/3304/
State Accepted
Commit r1387
Headers show

Comments

Uwe Hermann - 2011-07-24 13:17:54
See patch.


Uwe.
Carl-Daniel Hailfinger - 2011-07-24 19:32:00
Am 24.07.2011 15:17 schrieb Uwe Hermann:
> Random manpage improvements and updates.
>
> Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de>
>
> Index: flashrom.8
> ===================================================================
> --- flashrom.8	(Revision 1380)
> +++ flashrom.8	(Arbeitskopie)
> @@ -12,13 +12,12 @@
>  .B flashrom
>  is a utility for detecting, reading, writing, verifying and erasing flash
>  chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
> -using a supported mainboard, but it also supports flashing of network cards
> -(NICs), SATA controller cards, and other external devices which can program
> -flash chips.
> +using a supported mainboard, but it also supports various external
> +PCI/USB/parallel-port/serial-port based devices which can program flash chips.
>  .PP
>  It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40,
>   

Sorry, Nack for that part. We can't expect users to deduce that we mean
"SATA controller" when we talk about "PCI based device which can program
flash chips". You can extend that sentence, but don't remove the
individual explicit device types.

Rest is
Acked-by: Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net>

Regards,
Carl-Daniel
Uwe Hermann - 2011-07-25 21:15:02
On Sun, Jul 24, 2011 at 09:32:00PM +0200, Carl-Daniel Hailfinger wrote:
> Am 24.07.2011 15:17 schrieb Uwe Hermann:
> > Random manpage improvements and updates.
> >
> > Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de>
> >
> > Index: flashrom.8
> > ===================================================================
> > --- flashrom.8	(Revision 1380)
> > +++ flashrom.8	(Arbeitskopie)
> > @@ -12,13 +12,12 @@
> >  .B flashrom
> >  is a utility for detecting, reading, writing, verifying and erasing flash
> >  chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
> > -using a supported mainboard, but it also supports flashing of network cards
> > -(NICs), SATA controller cards, and other external devices which can program
> > -flash chips.
> > +using a supported mainboard, but it also supports various external
> > +PCI/USB/parallel-port/serial-port based devices which can program flash chips.
> >  .PP
> >  It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40,
> >   
> 
> Sorry, Nack for that part. We can't expect users to deduce that we mean
> "SATA controller" when we talk about "PCI based device which can program
> flash chips". You can extend that sentence, but don't remove the
> individual explicit device types.
> 
> Rest is
> Acked-by: Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net>

Thanks, r1387, with the changes above.

Dunno about listing _all_ types/programmers in the first paragraph, it's
getting a bit long, maybe we should just add a reference to the resp.
programmer chapter or something like that.


Uwe.

Patch

Random manpage improvements and updates.

Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de>

Index: flashrom.8
===================================================================
--- flashrom.8	(Revision 1380)
+++ flashrom.8	(Arbeitskopie)
@@ -1,4 +1,4 @@ 
-.TH FLASHROM 8 "Jun 14, 2011"
+.TH FLASHROM 8 "Jul 24, 2011"
 .SH NAME
 flashrom \- detect, read, write, verify and erase flash chips
 .SH SYNOPSIS
@@ -12,13 +12,12 @@ 
 .B flashrom
 is a utility for detecting, reading, writing, verifying and erasing flash
 chips. It's often used to flash BIOS/EFI/coreboot/firmware images in-system
-using a supported mainboard, but it also supports flashing of network cards
-(NICs), SATA controller cards, and other external devices which can program
-flash chips.
+using a supported mainboard, but it also supports various external
+PCI/USB/parallel-port/serial-port based devices which can program flash chips.
 .PP
 It supports a wide range of DIP32, PLCC32, DIP8, SO8/SOIC8, TSOP32, TSOP40,
-and TSOP48 chips, which use various protocols such as LPC, FWH, parallel flash,
-or SPI.
+TSOP48, and BGA chips, which use various protocols such as LPC, FWH,
+parallel flash, or SPI.
 .SH OPTIONS
 .B IMPORTANT:
 Please note that the command line interface for flashrom will change before
@@ -30,7 +29,7 @@ 
 or no operation.
 If no operation is specified, flashrom will only probe for flash chips. It is
 recommended that if you try flashrom the first time on a system, you run it
-in probe only mode and check the output. Also you are advised to make a
+in probe-only mode and check the output. Also you are advised to make a
 backup of your current ROM contents with
 .B \-r
 before you try to write a new image.
@@ -38,6 +37,7 @@ 
 .B "\-r, \-\-read <file>"
 Read flash ROM contents and save them into the given
 .BR <file> .
+If the file already exists, it will be overwritten.
 .TP
 .B "\-w, \-\-write <file>"
 Write
@@ -144,7 +144,8 @@ 
 from flash layout.
 .TP
 .B "\-L, \-\-list\-supported"
-List the flash chips, chipsets, mainboards, and PCI card "programmers"
+List the flash chips, chipsets, mainboards, and external programmers
+(including PCI, USB, parallel port, and serial port based devices)
 supported by flashrom.
 .sp
 There are many unlisted boards which will work out of the box, without
@@ -160,8 +161,9 @@ 
 Same as
 .BR \-\-list\-supported ,
 but outputs the supported hardware in MediaWiki syntax, so that it can be
-easily pasted into the wiki page at http://www.flashrom.org/. Please note
-that MediaWiki output is not compiled in by default.
+easily pasted into the wiki page at
+.BR http://www.flashrom.org/ .
+Please note that MediaWiki output is not compiled in by default.
 .TP
 .B "\-p, \-\-programmer <name>[:parameter[,parameter[,parameter]]]"
 Specify the programmer device. Currently supported are:
@@ -448,7 +450,7 @@ 
 four. Make sure to not forget the "0x" prefix for hexadecimal port addresses.
 .sp
 More information about the hardware is available at
-http://rayer.ic.cz/elektro/spipgm.htm
+.BR http://rayer.ic.cz/elektro/spipgm.htm .
 .TP
 .BR "ogp_spi " programmer
 The flash ROM chip to access must be specified with the 
@@ -476,7 +478,7 @@ 
 section above.
 .sp
 More information about the hardware is available at
-http://wiki.opengraphics.org
+.BR http://wiki.opengraphics.org .
 .SH EXIT STATUS
 flashrom exits with 0 on success, 1 on most failures but with 2 if /dev/mem
 (/dev/xsvc on Solaris) can not be opened and with 3 if a call to mmap() fails.
@@ -529,8 +531,10 @@ 
 needs PCI configuration space read access and raw memory access.
 .sp
 On OpenBSD, you can obtain raw access permission by setting
-securelevel=-1 in /etc/rc.securelevel and rebooting, or rebooting into single
-user mode.
+.B "securelevel=-1"
+in
+.B "/etc/rc.securelevel"
+and rebooting, or rebooting into single user mode.
 .SH BUGS
 Please report any bugs at
 .sp
@@ -548,6 +552,10 @@ 
 backup. This is caused by the embedded controller (EC) present in many laptops,
 which interacts badly with any flash attempts. This is a hardware limitation
 and flashrom will attempt to detect it and abort immediately for safety reasons.
+.sp
+More information about flashrom on laptops is available from
+.sp
+.B "  http://www.flashrom.org/Laptops"
 .SH LICENSE
 .B flashrom
 is covered by the GNU General Public License (GPL), version 2. Some files are