Documentation fixes and updates (trivial).

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



git-svn-id: svn://svn.coreboot.org/coreboot/trunk@2875 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1

util/flashrom/README

@@ -18,8 +18,8 @@ installed on your Linux system:
 Usage
 -----
 
-usage: ./flashrom [-rwvEVfh] [-c chipname] [-s exclude_start]
+ $ flashrom [-rwvEVfh] [-c chipname] [-s exclude_start] [-e exclude_end]
-       [-e exclude_end] [-m vendor:part] [-l file.layout] [-i imagename] [file]
+            [-m vendor:part] [-l file.layout] [-i imagename] [file]
    -r | --read:                    read flash and save into file
    -w | --write:                   write file into flash (default when
                                    file is specified)
@@ -41,11 +41,11 @@ usage: ./flashrom [-rwvEVfh] [-c chipname] [-s exclude_start]
 LinuxBIOS Table and Mainboard Identification
 --------------------------------------------
 
-Flashrom reads the LinuxBIOS table to determine the current mainboard.
+Flashrom reads the LinuxBIOS table to determine the current mainboard
-(Parse DMI as well in future?) If no LinuxBIOS table could be read
+(parse DMI as well in future?). If no LinuxBIOS table could be read
 or if you want to override these values, you can specify -m, e.g.:
 
-  flashrom -w --mainboard ISLAND:ARUMA island_aruma.rom
+  flashrom -w --mainboard AGAMI:ARUMA agami_aruma.rom
 
 The following boards require the specification of the board name, if
 no LinuxBIOS table is found:
@@ -55,8 +55,10 @@ no LinuxBIOS table is found:
 * ASUS P5A: use -m asus:p5a
 * IBM x3455: use -m ibm:x3455
 * EPoX EP-BX3: use -m epox:ep-bx3
-* GIGABYTE GA-M57SLI v2.0: use -m gigabyte:m57sli
+* GIGABYTE GA-M57SLI-S4 v2.0: use -m gigabyte:m57sli
-* GIGABYTE GA-M61P-S3: use -m gigabyte:m61ps3
+* GIGABYTE GA-M61P-S3: use -m gigabyte:m61p
+* MSI K8N Neo3: use -m msi:k8n-neo3
+
 
 ROM Layout Support
 ------------------
@@ -71,27 +73,27 @@ the flash chip only. A ROM layout file looks like follows:
   i.e.:
   startaddr:endaddr name
 
-  all addresses are offsets within the file, not absolute addresses!
+  All addresses are offsets within the file, not absolute addresses!
   
 If you only want to update the normal image in a ROM you can say:
 
-     flashrom -w --layout rom.layout --image normal island_aruma.rom
+  flashrom -w --layout rom.layout --image normal agami_aruma.rom
      
 To update normal and fallback but leave the VGA BIOS alone, say:
 
-     flashrom -w -l rom.layout -i normal -i fallback island_aruma.rom
+  flashrom -w -l rom.layout -i normal -i fallback agami_aruma.rom
  
 Currently overlapping sections are not supported.
 
 ROM layouts should replace the -s and -e option since they are more 
 flexible and they should lead to a ROM update file format with the 
-ROM layout and the ROM image in one file (cpio, zip or something?)
+ROM layout and the ROM image in one file (cpio, zip or something?).
 
 
-DOC support
+Disk on Chip support
------------
+--------------------
 
-DISK on Chip support is currently disabled since it is considered unstable. 
+Disk on Chip support is currently disabled since it is considered unstable. 
 Change CFLAGS in the Makefile to enable it: Remove -DDISABLE_DOC from CFLAGS.
 
 

util/flashrom/flashrom.8

@@ -1,4 +1,4 @@
-.TH FLASHROM 8 "December 20, 2006"
+.TH FLASHROM 8 "October 18, 2007"
 .SH NAME
 flashrom \- a universal flash programming utility
 .SH SYNOPSIS
@@ -6,24 +6,23 @@ flashrom \- a universal flash programming utility
          [\fB-m\fR vendor:part] [\fB-l\fR file.layout] [\fB-i\fR image_name] [file]
 .SH DESCRIPTION
 .B flashrom
-is a universal flash programming utility for flash chips
+is a universal flash programming utility for DIP, PLCC, or SPI flash ROM
-(e.g. in DIP or PLCC packaging). It can be used to flash BIOS images,
+chips. It can be used to flash BIOS/LinuxBIOS/firmware images, for example.
-for example.
 .SH OPTIONS
 If no file is specified, then all that happens
 is that flash info is dumped and the flash chip is set to writable.
 .TP
 .B "\-r, \-\-read"
-Read flash and save contents into file.
+Read flash ROM contents an save them into the given file.
 .TP
 .B "\-w, \-\-write"
 Write file into flash (default when file is specified).
 .TP
 .B "\-v, \-\-verify"
-Verify flash against file.
+Verify the flash ROM contents against the given file.
 .TP
 .B "\-E, \-\-erase"
-Erase flash device.
+Erase the flash device.
 .TP
 .B "\-V, \-\-verbose"
 More verbose output.
@@ -38,16 +37,25 @@ Exclude start position. (obsolete)
 Exclude end postion. (obsolete)
 .TP
 .B "\-m, \-\-mainboard" <vendor:part>
-Override mainboard settings.
+Override mainboard settings. This option is needed for some mainboards,
+see the
+.B flashrom
+README for a list.
 .TP
 .B "\-f, \-\-force"
-Force write without checking image.
+Force write without checking whether the ROM image file is really meant
+to be used on this board.
+.sp
+Note: This check only works while LinuxBIOS is running, and only for those
+boards where the LinuxBIOS code supports it.
 .TP
 .B "\-l, \-\-layout" <layout.file>
 Read ROM layout from file.
 .TP
 .B "\-i, \-\-image" <name>
-Only flash image name from flash layout.
+Only flash image
+.B <name>
+from flash layout.
 .TP
 .B "\-h, \-\-help"
 Show a help text and exit.
@@ -55,13 +63,12 @@ Show a help text and exit.
 .\".B "\-\-version"
 .\"Show version information and exit.
 .SH BUGS
-Please report any bugs at http://tracker.linuxbios.org/trac/LinuxBIOS/.
+Please report any bugs at http://tracker.linuxbios.org/trac/LinuxBIOS/,
+or on the LinuxBIOS mailing list (http://linuxbios.org/Mailinglist).
 .SH LICENCE
 .B flashrom
 is covered by the GNU General Public License (GPL), version 2 or later.
-.SH SEE ALSO
+.\" .SH SEE ALSO
-.BR romcc (1),
-.BR abuild (1).
 .SH COPYRIGHT
 2000 Silicon Integrated System Corporation
 .br