Re: cvs commit: src/release/doc/en_US.ISO8859-1/relnotes/common new.sgml

From: Bruce A. Mah <bmah_at_FreeBSD.ORG>
Date: Tue, 25 Mar 2003 09:28:59 -0800
If memory serves me right, Wilko Bulte wrote:
> On Fri, Mar 21, 2003 at 04:12:18PM -0800, Bruce A. Mah wrote:

> > If/when somebody stumbles over this problem in future versions of
> > FreeBSD, they're probably not going to come back to the 4.8 release
> > notes to find it.  I'll leave it where it is, but after RELENG_4 is
> > open again, could you please insert this text into the hardware notes,
> > so it'll be there for future reference?  Thanks.
> 
> You mean release/doc/en_US.ISO8859-1/hardware/alpha/proc-alpha.sgml?

Yeah, that's what I meant.

> It is in there already, but I am sort-of worried (how many folks have
> Turbolasers at home? ;-) that people would not find it there.

Heh.  :-)

What I am concerned about is that I don't want to see the release
notes turn into a dumping ground for "various things that people
should know".  (Note that I am not accusing you or anybody else of
doing this...I'm just expressing a part of my criteria for figuring
out what kinds of material to add.)

More specifically:

1.  I truncate the release notes after every release.  If your item
    needs to be seen over multiple releases, then the release notes
    document is probably not permanent enough of a place to put it.
    Someplace such as the hardware notes, Handbook, or FAQ might be
    better.

2.  The release notes describe changes from one release to the next.
    It's true that a lot of people read it when upgrading, but that
    doesn't excuse them from looking at other sources of information
    (such as UPDATING).

This is not a huge problem, and I don't want to stop you (or anybody
else) from committing release notes changes.  If there's sufficient
time, I might ask for items to be redirected to places I think are
more appropriate.  But in any case I'm glad for the help that you and
others have given to the release documentation.

Thanks!

Bruce.

Received on Tue Mar 25 2003 - 09:29:02 UTC