Since the command line interface for flashrom will change for 1.0 (all-caps or no-caps for short options, exclude range syntax, etc.) we should tell users in the man page and the usage message about this.
Signed-off-by: Carl-Daniel Hailfinger c-d.hailfinger.devel.2006@gmx.net
Index: flashrom-usage_hint/flashrom.8 =================================================================== --- flashrom-usage_hint/flashrom.8 (Revision 444) +++ flashrom-usage_hint/flashrom.8 (Arbeitskopie) @@ -17,6 +17,11 @@ .B http://coreboot.org for details on coreboot) .SH OPTIONS +Please note that the command line interface for flashrom will change before +flashrom 1.0. Do not use flashrom in scripts or other automated tools without +checking that your flashrom version won't interpret them in a totally different +way. +.PP If no file is specified, then all that happens is that flash info is dumped and the flash chip is set to writable. .TP Index: flashrom-usage_hint/flashrom.c =================================================================== --- flashrom-usage_hint/flashrom.c (Revision 444) +++ flashrom-usage_hint/flashrom.c (Arbeitskopie) @@ -306,6 +306,10 @@ printf("usage: %s [-rwvEVfLhR] [-c chipname] [-s exclude_start]\n", name); printf(" [-e exclude_end] [-m [vendor:]part] [-l file.layout] [-i imagename] [file]\n"); + printf("Please note that the command line interface for flashrom will " + "change before flashrom 1.0. Do not use flashrom in scripts or " + "other automated tools without checking that your flashrom " + "version won't interpret them in a totally different way.\n\n"); printf (" -r | --read: read flash and save into file\n" " -w | --write: write file into flash\n"
Ping?
On 27.04.2009 18:43, Carl-Daniel Hailfinger wrote:
Since the command line interface for flashrom will change for 1.0 (all-caps or no-caps for short options, exclude range syntax, etc.) we should tell users in the man page and the usage message about this.
Signed-off-by: Carl-Daniel Hailfinger c-d.hailfinger.devel.2006@gmx.net
Index: flashrom-usage_hint/flashrom.8
--- flashrom-usage_hint/flashrom.8 (Revision 444) +++ flashrom-usage_hint/flashrom.8 (Arbeitskopie) @@ -17,6 +17,11 @@ .B http://coreboot.org for details on coreboot) .SH OPTIONS +Please note that the command line interface for flashrom will change before +flashrom 1.0. Do not use flashrom in scripts or other automated tools without +checking that your flashrom version won't interpret them in a totally different +way. +.PP If no file is specified, then all that happens is that flash info is dumped and the flash chip is set to writable. .TP Index: flashrom-usage_hint/flashrom.c =================================================================== --- flashrom-usage_hint/flashrom.c (Revision 444) +++ flashrom-usage_hint/flashrom.c (Arbeitskopie) @@ -306,6 +306,10 @@ printf("usage: %s [-rwvEVfLhR] [-c chipname] [-s exclude_start]\n", name); printf(" [-e exclude_end] [-m [vendor:]part] [-l file.layout] [-i imagename] [file]\n");
- printf("Please note that the command line interface for flashrom will "
"change before flashrom 1.0. Do not use flashrom in scripts or ""other automated tools without checking that your flashrom ""version won't interpret them in a totally different way.\n\n");
-----Original Message----- From: coreboot-bounces@coreboot.org [mailto:coreboot-bounces@coreboot.org] On Behalf Of Carl-Daniel Hailfinger Sent: Tuesday, April 28, 2009 7:29 AM To: Coreboot Subject: Re: [coreboot] [PATCH] flashrom: Tell users that the command line interface may change
Ping?
On 27.04.2009 18:43, Carl-Daniel Hailfinger wrote:
Since the command line interface for flashrom will change for 1.0 (all-caps or no-caps for short options, exclude range syntax, etc.) we should tell users in the man page and the usage message about this.
I don't consider myself an active flashrom developer, but my question is why not just change the interface now instead of adding an ominous warning?
Thanks, Myles
Myles Watson wrote:
I don't consider myself an active flashrom developer,
I think you just became one. :)
but my question is why not just change the interface now instead of adding an ominous warning?
Right, there is more state at: http://tracker.coreboot.org/trac/coreboot/ticket/100
flashrom: Change start/end -s and -e to -S and -E, and change erase -E to -e.
//Peter
On 28.04.2009 16:44, Peter Stuge wrote:
Myles Watson wrote:
but my question is why not just change the interface now instead of adding an ominous warning?
Right, there is more state at: http://tracker.coreboot.org/trac/coreboot/ticket/100
flashrom: Change start/end -s and -e to -S and -E, and change erase -E to -e.
Basically, finishing the interface (see also ticket 104) is one of the things holding back flashrom 1.0, and instead of waiting another 6 months to get 1.0 done, I thought we'd simply release the current tree, then restart development. Renaming these options is not that simple because the underlying internal infrastructure needs to be changed as well. Such patches are definitely not 0.9.0 material.
Regards, Carl-Daniel
On Tue, Apr 28, 2009 at 04:51:55PM +0200, Carl-Daniel Hailfinger wrote:
Right, there is more state at: http://tracker.coreboot.org/trac/coreboot/ticket/100
flashrom: Change start/end -s and -e to -S and -E, and change erase -E to -e.
Basically, finishing the interface (see also ticket 104) is one of the things holding back flashrom 1.0, and instead of waiting another 6 months to get 1.0 done, I thought we'd simply release the current tree,
Yep.
Acked-by: Uwe Hermann uwe@hermann-uwe.de
Uwe.
On 28.04.2009 19:00, Uwe Hermann wrote:
On Tue, Apr 28, 2009 at 04:51:55PM +0200, Carl-Daniel Hailfinger wrote:
Right, there is more state at: http://tracker.coreboot.org/trac/coreboot/ticket/100
flashrom: Change start/end -s and -e to -S and -E, and change erase -E to -e.
Basically, finishing the interface (see also ticket 104) is one of the things holding back flashrom 1.0, and instead of waiting another 6 months to get 1.0 done, I thought we'd simply release the current tree,
Yep.
Acked-by: Uwe Hermann uwe@hermann-uwe.de
Thanks, r447.
Regards, Carl-Daniel
-
Carl-Daniel Hailfinger -
Myles Watson -
Peter Stuge -
Uwe Hermann