[LinuxBIOS] PATCH: flashrom documentation fixes.

Uwe Hermann uwe at hermann-uwe.de
Tue Aug 1 01:49:49 CEST 2006


Hi,

here's a small patch which fixes minor issues in the flashrom docs:

 * Made the README, manpage, and ./flashrom -h output the same things
 * Added some missing options to the "usage:" one-liner
 * Aligned spaces in ./flashrom -h output
 * Added explicit license to the manpage (GPL).


HTH, Uwe.
-- 
Uwe Hermann 
http://www.hermann-uwe.de
http://www.it-services-uh.de  | http://www.crazy-hacks.org 
http://www.holsham-traders.de | http://www.unmaintained-free-software.org
-------------- next part --------------
Index: flash_rom.c
===================================================================
--- flash_rom.c	(revision 2349)
+++ flash_rom.c	(working copy)
@@ -145,22 +145,24 @@
 
 void usage(const char *name)
 {
-	printf("usage: %s [-rwvE] [-V] [-c chipname] [-s exclude_start] [-e exclude_end] [file]\n", name);
-	printf("   -r | --read:   read flash and save into file\n"
-	       "   -w | --write:  write file into flash (default when file is specified)\n"
-	       "   -v | --verify: verify flash against file\n"
-	       "   -E | --erase: Erase flash device\n"
-	       "   -V | --verbose: more verbose output\n\n"
-	       "   -c | --chip <chipname>: probe only for specified flash chip\n"
-	       "   -s | --estart <addr>: exclude start position\n"
-	       "   -e | --eend <addr>: exclude end postion\n"
+	printf("usage: %s [-rwvEVfh] [-c chipname] [-s exclude_start]\n", name);
+	printf("       [-e exclude_end] [-m vendor:part] [-l file.layout] [-i imagename] [file]\n");
+	printf("   -r | --read:                    read flash and save into file\n"
+	       "   -w | --write:                   write file into flash (default when\n"
+	       "                                   file is specified)\n"
+	       "   -v | --verify:                  verify flash against file\n"
+	       "   -E | --erase:                   erase flash device\n"
+	       "   -V | --verbose:                 more verbose output\n"
+	       "   -c | --chip <chipname>:         probe only for specified flash chip\n"
+	       "   -s | --estart <addr>:           exclude start position\n"
+	       "   -e | --eend <addr>:             exclude end postion\n"
 	       "   -m | --mainboard <vendor:part>: override mainboard settings\n"
-	       "   -f | --force: force write without checking image\n"
-	       "   -l | --layout <file.layout>: read rom layout from file\n"
-	       "   -i | --image <name>: only flash image name from flash layout\n"
+	       "   -f | --force:                   force write without checking image\n"
+	       "   -l | --layout <file.layout>:    read rom layout from file\n"
+	       "   -i | --image <name>:            only flash image name from flash layout\n"
 	       "\n"
 	       " If no file is specified, then all that happens\n"
-	       " is that flash info is dumped\n\n");
+	       " is that flash info is dumped.\n\n");
 	exit(1);
 }
 
Index: README
===================================================================
--- README	(revision 2349)
+++ README	(working copy)
@@ -13,21 +13,21 @@
 usage
 -----
 
-usage: ./flashrom [-rwvE] [-V] [-c chipname] 
-                           [-s exclude_start] [-e exclude_end] [file]
-
-   -r | --read:   read flash and save into file
-   -w | --write:  write file into flash (default when file is specified)
-   -v | --verify: verify flash against file
-   -E | --erase: Erase flash device
-   -V | --verbose: more verbose output
-
-   -c | --chip <chipname>: probe only for specified flash chip
-   -s | --estart <addr>: exclude start position
-   -e | --eend <addr>: exclude end postion
+usage: ./flashrom [-rwvEVfh] [-c chipname] [-s exclude_start]
+       [-e exclude_end] [-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)
+   -v | --verify:                  verify flash against file
+   -E | --erase:                   erase flash device
+   -V | --verbose:                 more verbose output
+   -c | --chip <chipname>:         probe only for specified flash chip
+   -s | --estart <addr>:           exclude start position
+   -e | --eend <addr>:             exclude end postion
    -m | --mainboard <vendor:part>: override mainboard settings
-   -l | --layout <file.layout>: read rom layout from file
-   -i | --image <name>: only flash image name from flash layout
+   -f | --force:                   force write without checking image
+   -l | --layout <file.layout>:    read rom layout from file
+   -i | --image <name>:            only flash image name from flash layout
 
  If no file is specified, then all that happens
  is that flash info is dumped and the flash chip is set to writable.
Index: flashrom.1
===================================================================
--- flashrom.1	(revision 2349)
+++ flashrom.1	(working copy)
@@ -1,3 +1,5 @@
+.\" Copyright (C) 2006 Uwe Hermann <uwe at hermann-uwe.de>.
+.\" This manpage is licensed under the terms of the GNU GPL.
 .TH FLASHROM 1 "July 26, 2006"
 .SH NAME
 flashrom \- the universal LinuxBIOS flash utility
@@ -2,5 +4,4 @@
 .SH SYNOPSIS
-.B flashrom \fR[\fB\-rwvEVflih\fR] [\fB\-c\fR chipname]
-         [\fB\-s\fR exclude_start] [\fB\-e\fR exclude_end]
-         [\fB-m\fR vendor:part] [file]
+.B flashrom \fR[\fB\-rwvEVfh\fR] [\fB\-c\fR chipname] [\fB\-s\fR exclude_start] [\fB\-e\fR exclude_end]
+         [\fB-m\fR vendor:part] [\fB-l\fR file.layout] [\fB-i\fR image_name] [file]
 .SH DESCRIPTION
@@ -42,7 +43,7 @@
 .B "\-f, \-\-force"
 Force write without checking image.
 .PP
-.B "\-l, \-\-layout"
+.B "\-l, \-\-layout" <layout.file>
 Read ROM layout from file.
 .PP
 .B "\-i, \-\-image" <name>
@@ -54,7 +55,7 @@
 .\".B "\-\-version"
 .\"Show version information and exit.
 .SH BUGS
-Please report any bugs at http://bugzilla.openbios.org/
+Please report any bugs at http://bugzilla.openbios.org/.
 .SH LICENCE
 .B flashrom
 is covered by the GNU General Public License (GPL).
@@ -63,11 +64,11 @@
 .SH COPYRIGHT
 2000 Silicon Integrated System Corporation
 .br
+2003 Niki W. Waibel
+.br
 2004 Tyan Corp
 .br
 2005-2006 coresystems GmbH
-.br
-2003 Niki W. Waibel
 .SH AUTHORS
 Yhlu <yinghai.lu at amd.com>
 .br
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://www.coreboot.org/pipermail/coreboot/attachments/20060801/57098fab/attachment.sig>


More information about the coreboot mailing list