[PATCH] Update man page

[Carl-Daniel Hailfinger]

Update the man page to have correct info for the upcoming release.

If you know of any features which are not mentioned in the man page,
please tell me.
If you know any major contributors who were forgotten, please tell me.
If you find any bugs, please tell me.

Should we mention all contributors with more than one patch? Should we
restrict the author list to those who have substantial amounts of code
in flashrom? Do we have to ask people if adding their email address to
the manpage is OK?

Should we mention the flashrom mailing list e-mail address in the man
page and kill all other email addresses?

Signed-off-by: Carl-Daniel Hailfinger

Index: flashrom-manpage/flashrom.8
===================================================================
--- flashrom-manpage/flashrom.8	(Revision 1194)
+++ flashrom-manpage/flashrom.8	(Arbeitskopie)
@@ -97,7 +97,7 @@
 .sp
 * Force chip read and pretend the chip is there.
 .sp
-* Force chip access even if the chip is bigger than the maximum supported\
+* Force chip access even if the chip is bigger than the maximum supported \
 size for the flash bus.
 .sp
 * Force erase even if erase is known bad.
@@ -169,6 +169,9 @@
 .sp
 .BR "* nicsmc1211" " (for flash ROMs on RTL8139-compatible SMC2 network cards)"
 .sp
+.BR "* nicnatsemi" " (for flash ROMs on National Semiconductor DP838* network \
+cards)"
+.sp
 .BR "* gfxnvidia" " (for flash ROMs on NVIDIA graphics cards)"
 .sp
 .BR "* drkaiser" " (for flash ROMs on Dr. Kaiser PC-Waechter PCI cards)"
@@ -187,6 +190,8 @@
 .sp
 .BR "* buspirate_spi" " (for SPI flash ROMs attached to a Bus Pirate)"
 .sp
+.BR "* dediprog" " (for SPI flash ROMs attached to a Dediprog SF100)"
+.sp
 .BR "* rayer_spi" " (for SPI flash ROMs attached to a RayeR parport \
 based programmer)"
 .sp
@@ -313,8 +318,8 @@
 Example:
 .B "flashrom -p dummy:bus=lpc+fwh"
 .TP
-.BR "nic3com" , " nicrealtek" , " nicsmc1211" , " gfxnvidia" , " satasii \
-" and " atahpt " programmers
+.BR "nic3com" , " nicrealtek" , " nicsmc1211" , " nicnatsemi" , " gfxnvidia\
+" , " satasii " and " atahpt " programmers
 These programmers have an option to specify the PCI address of the card
 your want to use, which must be specified if more than one card supported
 by the selected programmer is installed in your system. The syntax is
@@ -396,6 +401,9 @@
 .BR 30k ", " 125k ", " 250k ", " 1M ", " 2M ", " 2.6M ", " 4M ", " 8M
 (in Hz). The default is the maximum frequency of 8 MHz.
 .TP
+.BR "dediprog " programmer
+No parameters defined yet.
+.TP
 .BR "rayer_spi " programmer
 The default I/O base address used for the parallel port is 0x378 and you can use
 the optional
@@ -484,28 +492,48 @@
 .br
 Please see the individual files.
 .SH AUTHORS
+Andrew Morgan 
+.br
 Carl-Daniel Hailfinger
 .br
 Claus Gindhart 
 .br
+David Borg 
+.br
+David Hendricks 
+.br
 Dominik Geyer 
 .br
 Eric Biederman
 .br
 Giampiero Giancipoli 
 .br
+Helge Wagner 
+.br
+Idwer Vollering 
+.br
 Joe Bao 
 .br
+Jörg Fischer 
+.br
+Joshua Roys 
+.br
 Luc Verhaegen 
 .br
 Li-Ta Lo
 .br
 Markus Boas 
 .br
+Mattias Mattsson 
+.br
 Michael Karcher 
 .br
 Nikolay Petukhov 
 .br
+Patrick Georgi 
+.br
+Peter Lemenkov 
+.br
 Peter Stuge 
 .br
 Reinder E.N. de Haan 
@@ -520,6 +548,8 @@
 .br
 Stefan Wildemann 
 .br
+Stephan Guilloux 
+.br
 Steven James 
 .br
 Uwe Hermann

[Uwe Hermann]

On Wed, Oct 06, 2010 at 01:19:47AM +0200, Carl-Daniel Hailfinger wrote:
> Update the man page to have correct info for the upcoming release.

Looks good.

Acked-by: Uwe Hermann
> Should we mention all contributors with more than one patch? Should we
> restrict the author list to those who have substantial amounts of code
> in flashrom? Do we have to ask people if adding their email address to
> the manpage is OK?

I'd rather remove the whole list to be honest, it's tedious to keep
up-to-date and the manpage is the wrong place anyway IMHO (yes, I know
I'm the one who added it there in the first place).

A short sentence like "Thanks to all contributors" is sufficient IMHO,
the details are in (C) lines in the source or in

svn log | grep -i Signed-off-by

or similar.

Uwe.

[Carl-Daniel Hailfinger]

On 06.10.2010 23:57, Uwe Hermann wrote:
> On Wed, Oct 06, 2010 at 01:19:47AM +0200, Carl-Daniel Hailfinger wrote:
> > Update the man page to have correct info for the upcoming release.
>
> Looks good.
>
> Acked-by: Uwe Hermann

Thanks, committed in r1197.
> > Should we mention all contributors with more than one patch? Should we
> > restrict the author list to those who have substantial amounts of code
> > in flashrom? Do we have to ask people if adding their email address to
> > the manpage is OK?
>
> I'd rather remove the whole list to be honest, it's tedious to keep
> up-to-date and the manpage is the wrong place anyway IMHO (yes, I know
> I'm the one who added it there in the first place).
>
> A short sentence like "Thanks to all contributors" is sufficient IMHO,
> the details are in (C) lines in the source or in
>
> svn log | grep -i Signed-off-by
>
> or similar.

Mh. The early authors are missing in that list. You do have a point,
though. Did you mean something like this?

Signed-off-by: Carl-Daniel Hailfinger

Index: flashrom-manpage/flashrom.8
===================================================================
--- flashrom-manpage/flashrom.8	(revision 1199)
+++ flashrom-manpage/flashrom.8	(working copy)
@@ -476,7 +476,10 @@
 .B "  http://www.flashrom.org/trac/flashrom/newticket"
 .sp
 or on the flashrom mailing list at
+.B ""
 .sp
+We recommend to subscribe first at
+.sp
 .B "  http://www.flashrom.org/mailman/listinfo/flashrom"
 .sp
 Using flashrom on laptops is dangerous and may easily make your hardware
@@ -492,73 +495,75 @@
 .br
 Please see the individual files.
 .SH AUTHORS
-Andrew Morgan 
+Andrew Morgan
 .br
 Carl-Daniel Hailfinger
 .br
-Claus Gindhart 
+Claus Gindhart
 .br
-David Borg 
+David Borg
 .br
-David Hendricks 
+David Hendricks
 .br
-Dominik Geyer 
+Dominik Geyer
 .br
 Eric Biederman
 .br
-Giampiero Giancipoli 
+Giampiero Giancipoli
 .br
-Helge Wagner 
+Helge Wagner
 .br
-Idwer Vollering 
+Idwer Vollering
 .br
-Joe Bao 
+Joe Bao
 .br
-Jörg Fischer 
+Jörg Fischer
 .br
-Joshua Roys 
+Joshua Roys
 .br
-Luc Verhaegen 
+Luc Verhaegen
 .br
 Li-Ta Lo
 .br
-Markus Boas 
+Markus Boas
 .br
-Mattias Mattsson 
+Mattias Mattsson
 .br
-Michael Karcher 
+Michael Karcher
 .br
-Nikolay Petukhov 
+Nikolay Petukhov
 .br
-Patrick Georgi 
+Patrick Georgi
 .br
-Peter Lemenkov 
+Peter Lemenkov
 .br
-Peter Stuge 
+Peter Stuge
 .br
-Reinder E.N. de Haan 
+Reinder E.N. de Haan
 .br
-Ronald G. Minnich 
+Ronald G. Minnich
 .br
-Ronald Hoogenboom 
+Ronald Hoogenboom
 .br
-Sean Nelson 
+Sean Nelson
 .br
-Stefan Reinauer 
+Stefan Reinauer
 .br
-Stefan Wildemann 
+Stefan Wildemann
 .br
-Stephan Guilloux 
+Stephan Guilloux
 .br
-Steven James 
+Steven James
 .br
-Uwe Hermann 
+Uwe Hermann
 .br
 Wang Qingpei
 .br
 Yinghai Lu
 .br
-some others 
+some others, please see the flashrom svn changelog for details.
+.br
+All authors can be reached via e-mail at .
 .PP
 This manual page was written by Uwe Hermann 
 and Carl-Daniel Hailfinger.

[Carl-Daniel Hailfinger]

On 07.10.2010 02:56, Carl-Daniel Hailfinger wrote:
> On 06.10.2010 23:57, Uwe Hermann wrote:
> > On Wed, Oct 06, 2010 at 01:19:47AM +0200, Carl-Daniel Hailfinger wrote:
> > > Update the man page to have correct info for the upcoming release.
> >
> > Looks good.
> >
> > Acked-by: Uwe Hermann
>
> Thanks, committed in r1197.
> > > Should we mention all contributors with more than one patch? Should we
> > > restrict the author list to those who have substantial amounts of code
> > > in flashrom? Do we have to ask people if adding their email address to
> > > the manpage is OK?
> >
> > I'd rather remove the whole list to be honest, it's tedious to keep
> > up-to-date and the manpage is the wrong place anyway IMHO (yes, I know
> > I'm the one who added it there in the first place).
> >
> > A short sentence like "Thanks to all contributors" is sufficient IMHO,
> > the details are in (C) lines in the source or in
> >
> > svn log | grep -i Signed-off-by
> >
> > or similar.
>
> Mh. The early authors are missing in that list. You do have a point,
> though. Did you mean something like this?

New version. Additional doc updates and fixes.

Signed-off-by: Carl-Daniel Hailfinger

Index: flashrom-authors_programmer_doc/pcidev.c
===================================================================
--- flashrom-authors_programmer_doc/pcidev.c	(Revision 1199)
+++ flashrom-authors_programmer_doc/pcidev.c	(Arbeitskopie)
@@ -134,7 +134,7 @@

msg_pinfo("PCI devices:\n");
    for (i = 0; devs[i].vendor_name != NULL; i++) {
-		msg_pinfo("%s %s [%02x:%02x]%s\n", devs[i].vendor_name,
+		msg_pinfo("%s %s [%04x:%04x]%s\n", devs[i].vendor_name,
    	       devs[i].device_name, devs[i].vendor_id,
    	       devs[i].device_id,
    	       (devs[i].status == NT) ? " (untested)" : "");
Index: flashrom-authors_programmer_doc/flashrom.8
===================================================================
--- flashrom-authors_programmer_doc/flashrom.8	(Revision 1199)
+++ flashrom-authors_programmer_doc/flashrom.8	(Arbeitskopie)
@@ -476,7 +476,10 @@
 .B "  http://www.flashrom.org/trac/flashrom/newticket"
 .sp
 or on the flashrom mailing list at
+.B ""
 .sp
+We recommend to subscribe first at
+.sp
 .B "  http://www.flashrom.org/mailman/listinfo/flashrom"
 .sp
 Using flashrom on laptops is dangerous and may easily make your hardware
@@ -492,73 +495,75 @@
 .br
 Please see the individual files.
 .SH AUTHORS
-Andrew Morgan 
+Andrew Morgan
 .br
 Carl-Daniel Hailfinger
 .br
-Claus Gindhart 
+Claus Gindhart
 .br
-David Borg 
+David Borg
 .br
-David Hendricks 
+David Hendricks
 .br
-Dominik Geyer 
+Dominik Geyer
 .br
 Eric Biederman
 .br
-Giampiero Giancipoli 
+Giampiero Giancipoli
 .br
-Helge Wagner 
+Helge Wagner
 .br
-Idwer Vollering 
+Idwer Vollering
 .br
-Joe Bao 
+Joe Bao
 .br
-Jörg Fischer 
+Jörg Fischer
 .br
-Joshua Roys 
+Joshua Roys
 .br
-Luc Verhaegen 
+Luc Verhaegen
 .br
 Li-Ta Lo
 .br
-Markus Boas 
+Markus Boas
 .br
-Mattias Mattsson 
+Mattias Mattsson
 .br
-Michael Karcher 
+Michael Karcher
 .br
-Nikolay Petukhov 
+Nikolay Petukhov
 .br
-Patrick Georgi 
+Patrick Georgi
 .br
-Peter Lemenkov 
+Peter Lemenkov
 .br
-Peter Stuge 
+Peter Stuge
 .br
-Reinder E.N. de Haan 
+Reinder E.N. de Haan
 .br
-Ronald G. Minnich 
+Ronald G. Minnich
 .br
-Ronald Hoogenboom 
+Ronald Hoogenboom
 .br
-Sean Nelson 
+Sean Nelson
 .br
-Stefan Reinauer 
+Stefan Reinauer
 .br
-Stefan Wildemann 
+Stefan Wildemann
 .br
-Stephan Guilloux 
+Stephan Guilloux
 .br
-Steven James 
+Steven James
 .br
-Uwe Hermann 
+Uwe Hermann
 .br
 Wang Qingpei
 .br
 Yinghai Lu
 .br
-some others 
+some others, please see the flashrom svn changelog for details.
+.br
+All authors can be reached via e-mail at .
 .PP
 This manual page was written by Uwe Hermann 
 and Carl-Daniel Hailfinger.
Index: flashrom-authors_programmer_doc/print.c
===================================================================
--- flashrom-authors_programmer_doc/print.c	(Revision 1199)
+++ flashrom-authors_programmer_doc/print.c	(Arbeitskopie)
@@ -238,6 +238,7 @@
    printf("\nSupported devices for the %s programmer:\n",
           programmer_table[PROGRAMMER_DUMMY].name);
    /* FIXME */
+	printf("Dummy device, does nothing and logs all accesses\n");
 #endif
 #if CONFIG_NIC3COM == 1
    printf("\nSupported devices for the %s programmer:\n",
@@ -286,21 +287,25 @@
    printf("\nSupported devices for the %s programmer:\n",
           programmer_table[PROGRAMMER_SERPROG].name);
    /* FIXME */
+	printf("All programmer devices speaking the serprog protocol\n");
 #endif
 #if CONFIG_BUSPIRATE_SPI == 1
    printf("\nSupported devices for the %s programmer:\n",
           programmer_table[PROGRAMMER_BUSPIRATE_SPI].name);
    /* FIXME */
+	printf("Dangerous Prototypes Bus Pirate\n");
 #endif
 #if CONFIG_DEDIPROG == 1
    printf("\nSupported devices for the %s programmer:\n",
           programmer_table[PROGRAMMER_DEDIPROG].name);
    /* FIXME */
+	printf("Dediprog SF100\n");
 #endif
 #if CONFIG_RAYER_SPI == 1
    printf("\nSupported devices for the %s programmer:\n",
           programmer_table[PROGRAMMER_RAYER_SPI].name);
    /* FIXME */
+	printf("RayeR parallel port programmer\n");
 #endif
 #if CONFIG_NICINTEL_SPI == 1
    printf("\nSupported devices for the %s programmer:\n",

[Uwe Hermann]

On Thu, Oct 07, 2010 at 03:45:00AM +0200, Carl-Daniel Hailfinger wrote:
> > Mh. The early authors are missing in that list. You do have a point,
> > though. Did you mean something like this?
>
> New version. Additional doc updates and fixes.

The print.c changes look good, yes, something like that is what I meant.

Manpage changes are also fine, though I still think it's best to just
remove the whole list of names and only refer to svn logs and (C) lines.
> Signed-off-by: Carl-Daniel Hailfinger

Acked-by: Uwe Hermann

Uwe.

[Carl-Daniel Hailfinger]

On 08.10.2010 00:14, Uwe Hermann wrote:
> On Thu, Oct 07, 2010 at 03:45:00AM +0200, Carl-Daniel Hailfinger wrote:
> > > Mh. The early authors are missing in that list. You do have a point,
> > > though. Did you mean something like this?
> >
> > New version. Additional doc updates and fixes.
>
> The print.c changes look good, yes, something like that is what I meant.
>
> Manpage changes are also fine, though I still think it's best to just
> remove the whole list of names and only refer to svn logs and (C) lines.

Ah OK.
Given that the number of contributors will grow, do we want some "core
team" listed in the man page, do we want a separate file AUTHORS, or
should we simply defer to the svn logs (which are a bit incomplete for
the earliest code)?
> > Signed-off-by: Carl-Daniel Hailfinger
>
> Acked-by: Uwe Hermann

Thanks, committed in r1200.

Regards,
Carl-Daniel