Bazaar 2.1.0 has gone gold
Martin Pool
mbp at canonical.com
Thu Feb 18 21:17:00 GMT 2010
On 18 February 2010 22:03, Andrew Bennetts
<andrew.bennetts at canonical.com> wrote:
> Ian Clatworthy wrote:
>> John Arbash Meinel wrote:
> I really like this text, but I'm not sure if it's a good fit for the
> NEWS file.
>
> Perhaps we should do it the way Python does it?
>
> Python has a NEWS file (which they keep in Misc/NEWS), which looks quite
> a lot like our NEWS file: a list of terse bullet points describing every
> non-trivial change, categorised into a few major sections. Each bullet
> usually has a bug number, and often credits the contributor by name.
> This is very very similar to our NEWS file. (So similar that I'm going
> to use it as a use-case for guiding enhancements to the news_merge
> plugin: if I can make it configurable enough for both ours and Python's,
> then I think it'll be in good shape.)
>
> However, as I'm sure you'd agree, most end users are better served by
> actual paragraphs of text telling them about the highlights, ideally
> with examples and even links to find out more. Python has this too:
> each release has a “What's New in Python X.Y” document.
>
> I think the same model would suit us too. NEWS files are great for
> people that really want to find out if bug 1234 was fixed in this
> release (that includes packagers and also users that have a pet bug).
> A “What's New” page is great for most users that just want to know what
> the interesting changes from X.Y to X.Z were — which is probably most
> users. But I think both audiences are important.
>
> An advantage to keeping these as separate docs is that point releases of
> a stable release can refine the “What's New” doc easily. And I think it
> the audience for a “What's New” page would be better served with the
> clutter of NEWS's bullets kept out of it (although providing a link to
> NEWS would make great sense, of course).
Let's do it! It's just about as easy to put this text into a branch
and mp as into a mail.
--
Martin <http://launchpad.net/~mbp/>
More information about the bazaar
mailing list