Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 4 Nov 2012 14:39:31 -0500
From:      Eitan Adler <lists@eitanadler.com>
To:        FBSD Doc project <doc@freebsd.org>
Subject:   what's the deal with changing release notes?
Message-ID:  <CAF6rxgk2Fx6YhEkb9sfLbMYssZRSUuOo6ZURoeQVC6X96WuYnQ@mail.gmail.com>
In-Reply-To: <CAF6rxgkEOcHCcJYiW0R9cZ4Nt8xeZP0bHVFC87Toqd_qr=Bgqw@mail.gmail.com>
References:  <CAF6rxgkEOcHCcJYiW0R9cZ4Nt8xeZP0bHVFC87Toqd_qr=Bgqw@mail.gmail.com>

next in thread | previous in thread | raw e-mail | index | archive | help
I'd like to commit the following patch but have been told that
changing release notes is special and they aren't supposed to be
changed once published. Why is this?

Right now some release notes have a  "bug"
and have already caused two PRs which is
(a) a waste of time for the project and (b) likely means that many
times that number have seen it and gotten annoyed.

It also looks completely unprofessional.

What's the actual policy on changing release notes, and why?

commit bfe955ef84302132ae222dd1e15615b0af5554a3
Author: Eitan Adler <lists@eitanadler.com>
Date:   Thu Nov 1 19:45:10 2012 -0400

    Fix odd quoting in the release announcmenets:  there have already
    been two PRs about this.

    It also looks odd and unprofessional.

    PR:         docs/172928
    Submitted by:       "A.AUDEBERT" <deuza@fr.FreeBSD.org>
    Discussed with:     brooks
    Approved by:        ??? (mentor)

diff --git a/en_US.ISO8859-1/htdocs/releases/8.3R/announce.xml
b/en_US.ISO8859-1/htdocs/releases/8.3R/announce.xml
index 1badd72..6036ee7 100644
--- a/en_US.ISO8859-1/htdocs/releases/8.3R/announce.xml
+++ b/en_US.ISO8859-1/htdocs/releases/8.3R/announce.xml
@@ -110,7 +110,7 @@
        USB drive appears as /dev/da0 on your machine something like this
        should work:</p>

-      <pre># dd if="FreeBSD"-8.3-RELEASE-amd64-memstick.img
of=/dev/da0 bs="10240" conv="sync"</pre>
+      <pre># dd if="FreeBSD-8.3-RELEASE-amd64-memstick.img"
of=/dev/da0 bs="10240" conv="sync"</pre>

       <p>Be careful to make sure you get the target (of=) correct.</p>
     </dd>
diff --git a/en_US.ISO8859-1/htdocs/releases/9.0R/announce.xml
b/en_US.ISO8859-1/htdocs/releases/9.0R/announce.xml
index 0567904..b93339a 100644
--- a/en_US.ISO8859-1/htdocs/releases/9.0R/announce.xml
+++ b/en_US.ISO8859-1/htdocs/releases/9.0R/announce.xml
@@ -152,7 +152,7 @@
        USB drive appears as /dev/da0 on your machine something like this
        should work:</p>

-      <pre># dd if="FreeBSD"-9.0-RELEASE-amd64-memstick.img
of=/dev/da0 bs="10240" conv="sync"</pre>
+      <pre># dd if="FreeBSD-9.0-RELEASE-amd64-memstick.img"
of=/dev/da0 bs="10240" conv="sync"</pre>

       <p>Be careful to make sure you get the target (of=) correct.</p>
     </dd>

-- 
Eitan Adler



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAF6rxgk2Fx6YhEkb9sfLbMYssZRSUuOo6ZURoeQVC6X96WuYnQ>