Mailing List Archive: NewStuff

NewStuff

Feb 5, 2008, 6:20 AM

Post #1 of 5 (11441 views)

Our documentation model is now to keep the main spec in sync with the
code, which means that the NewStuff file is much less important than it
was. However it seems that people value it as an appendix to printed
copies of the spec, so we shoulnd't get rid of it completely.

I propose that we should empty the NewStuff file at the start of each
development cycle (after a release) and add brief documentation of new
features to it, so that when we do a release it can act as an appendix to
the previous release's spec.

The ChangeLog will continue to list all changes.

Any comments?

Tony.
--
<fanf@exim.org> <dot@dotat.at> http://dotat.at/ ${sg{\N${sg{\
N\}{([^N]*)(.)(.)(.*)}{\$1\$3\$2\$1\$3\n\$2\$3\$4\$3\n\$3\$2\$4}}\
\N}{([^N]*)(.)(.)(.*)}{\$1\$3\$2\$1\$3\n\$2\$3\$4\$3\n\$3\$2\$4}}

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

Re: NewStuff [ In reply to ]

bob at db

Feb 5, 2008, 11:57 AM

Post #2 of 5 (10776 views)

Permalink

Tony Finch wrote:
> I propose that we should empty the NewStuff file at the start of each
> development cycle (after a release) and add brief documentation of new
> features to it, so that when we do a release it can act as an appendix to
> the previous release's spec.

How about renaming NewStuff to NewStuff-x.yz when version x.yz is
released, and leaving it in the distribution (at least until the end of
the x branch?

Bob (not an Exim developer, but a hardcore Exim documentation user)

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

Re: NewStuff [ In reply to ]

dean at iglou

Feb 5, 2008, 12:18 PM

Post #3 of 5 (10781 views)

Permalink

On Tue, Feb 05, 2008 at 08:57:11PM +0100, B. Johannessen wrote:
> Tony Finch wrote:
> > I propose that we should empty the NewStuff file at the start of each
> > development cycle (after a release) and add brief documentation of new
> > features to it, so that when we do a release it can act as an appendix to
> > the previous release's spec.
>
> How about renaming NewStuff to NewStuff-x.yz when version x.yz is
> released, and leaving it in the distribution (at least until the end of
> the x branch?

I would second that. If the file is wiped after each release, it
would require download each previous distribution if you are jumping
forward multiple revisions.

--
Dean Brooks
dean@iglou.com

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

Re: NewStuff [ In reply to ]

dot at dotat

Feb 6, 2008, 5:48 AM

Post #4 of 5 (10765 views)

Permalink

On Tue, 5 Feb 2008, Dean Brooks wrote:
> On Tue, Feb 05, 2008 at 08:57:11PM +0100, B. Johannessen wrote:
> >
> > How about renaming NewStuff to NewStuff-x.yz when version x.yz is
> > released, and leaving it in the distribution (at least until the end of
> > the x branch?

I'd prefer to just let the file grow, and not create clutter.

> I would second that. If the file is wiped after each release, it
> would require download each previous distribution if you are jumping
> forward multiple revisions.

I tend to think that that is what the ChangeLog is for, though I can see
the value of leaving 5 or 10 revisions worth of documentation in the
NewStuff file.

Tony.
--
<fanf@exim.org> <dot@dotat.at> http://dotat.at/ ${sg{\N${sg{\
N\}{([^N]*)(.)(.)(.*)}{\$1\$3\$2\$1\$3\n\$2\$3\$4\$3\n\$3\$2\$4}}\
\N}{([^N]*)(.)(.)(.*)}{\$1\$3\$2\$1\$3\n\$2\$3\$4\$3\n\$3\$2\$4}}

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

Re: NewStuff [ In reply to ]

maillist at ovb

Feb 6, 2008, 9:44 AM

Post #5 of 5 (10771 views)

Permalink

Tony Finch wrote:
> On Tue, 5 Feb 2008, Dean Brooks wrote:
>
>> On Tue, Feb 05, 2008 at 08:57:11PM +0100, B. Johannessen wrote:
>>
>>> How about renaming NewStuff to NewStuff-x.yz when version x.yz is
>>> released, and leaving it in the distribution (at least until the end of
>>> the x branch?
>>>
> I'd prefer to just let the file grow, and not create clutter.
>
>
>> I would second that. If the file is wiped after each release, it
>> would require download each previous distribution if you are jumping
>> forward multiple revisions.
>>
You can get the single NewStuff and ChangeLog files from the exim ftp
server under /pub/exim/ChangeLogs. There you have the naming convention
suggested above for those two files.
BTW: The NewStuff for 4.69 is missing there.

I like the NewStuff file as well, it enables me as a user of exim to
quickly get all the information required to update the software and use
the added features without going through the detailed ChangeLog.

Oliver

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##