[ovs-dev] NEWS vs. ChangeLog

Ben Pfaff blp at nicira.com
Mon Aug 8 16:54:01 UTC 2011


Well, I try, but it's difficult to remember.

On Mon, Aug 08, 2011 at 09:39:50AM -0700, Justin Pettit wrote:
> Thanks.  Now we just need to keep it up to date as we make changes, so I don't have to sift through hundreds of commit messages around the time of a release.  :)
> 
> --Justin
> 
> 
> On Aug 8, 2011, at 9:37 AM, Ben Pfaff wrote:
> 
> > OK, I pushed this change as detailed at the end of this email.
> > 
> > On Sun, Aug 07, 2011 at 04:58:51PM -0700, Justin Pettit wrote:
> >> I suspect you may be over-thinking it, since I think most people just don't read documentation.  :)  However, if it saves even one question, it's worth it.  In any case, it is probably a more appropriate title for what it includes.
> >> 
> >> Thanks,
> >> 
> >> --Justin
> >> 
> >> 
> >> On Aug 4, 2011, at 9:50 PM, Ben Pfaff wrote:
> >> 
> >>> I've noticed that many users seem to miss changes that we clearly state
> >>> in ChangeLog.  Some of this is probably due to users not reading any
> >>> documentation ever, but I wonder whether some of it is because users
> >>> expect ChangeLog to be akin to a commit log, because that's what GNU
> >>> software puts in ChangeLog.  Users don't read GNU ChangeLogs, because
> >>> they don't contain information useful to users.
> >>> 
> >>> GNU software puts what we have in ChangeLog in a file named NEWS.  Some
> >>> users read it.  Therefore: would you mind if we renamed ChangeLog to
> >>> NEWS?
> >>> 
> >>> Thanks,
> >>> 
> >>> Ben.
> >> 
> > 
> > --8<--------------------------cut here-------------------------->8--
> > 
> > From: Ben Pfaff <blp at nicira.com>
> > Date: Mon, 8 Aug 2011 09:35:01 -0700
> > Subject: [PATCH] ChangeLog: Rename NEWS.
> > 
> > Many users seem to miss changes that Open vSwitch clearly states in
> > ChangeLog.  Some of this is probably due to users not reading any
> > documentation ever, but I wonder whether some of it is because users
> > expect ChangeLog to be akin to a commit log, because that's what GNU
> > software puts in ChangeLog.  Users don't read GNU ChangeLogs, because
> > they don't contain information useful to users.
> > 
> > GNU software puts what we have in ChangeLog in a file named NEWS.  Some
> > users read it.  Therefore, this commit renames ChangeLog to NEWS.
> > 
> > Also, strip trailing whitespace for Ethan-compliance.
> > ---
> > ChangeLog => NEWS |    4 ++--
> > 1 files changed, 2 insertions(+), 2 deletions(-)
> > rename ChangeLog => NEWS (99%)
> > 
> > diff --git a/ChangeLog b/NEWS
> > similarity index 99%
> > rename from ChangeLog
> > rename to NEWS
> > index 6dab0b3..b31b127 100644
> > --- a/ChangeLog
> > +++ b/NEWS
> > @@ -88,7 +88,7 @@ v1.1.0 - 05 Apr 2011
> >       bugs.  New ovs-vlan-bug-workaround command for enabling and
> >       disabling a workaround for these driver bugs.
> >     - OpenFlow support:
> > -      - "Resubmit" actions now update flow statistics. 
> > +      - "Resubmit" actions now update flow statistics.
> >       - New "register" extension for use in matching and actions, via NXM.
> >       - New "multipath" experimental action extension.
> >       - New support for matching multicast Ethernet frames, via NXM.
> > @@ -167,7 +167,7 @@ v0.99.0 - 14 Jan 2010
> > ---------------------
> >     - User-space forwarding engine
> >     - Bug fixes
> > -	
> > +
> > v0.90.7 - 29 Nov 2009
> > ---------------------
> >     - Add support for NetFlow active timeouts
> > -- 
> > 1.7.4.4
> > 
> 



More information about the dev mailing list