Date: Sun, 23 Jun 2019 14:01:31 -0600 From: Warner Losh <imp@bsdimp.com> To: Glen Barber <gjb@freebsd.org> Cc: Mark Johnston <markj@freebsd.org>, "freebsd-hackers@freebsd.org" <freebsd-hackers@freebsd.org>, FreeBSD Release Engineering Team <re@freebsd.org> Subject: Re: release notes file Message-ID: <CANCZdfrvv9x3EyS=cgFQhKs6kNC9pnz5dnPziLbvYoyOT8UuZw@mail.gmail.com> In-Reply-To: <79B7AEEE-7617-44D8-A16A-C8EC5F95455A@FreeBSD.org> References: <20190623191818.GA84365@raichu> <6B485E5C-9C8A-43C8-BD5A-528A74A61A23@FreeBSD.org> <79B7AEEE-7617-44D8-A16A-C8EC5F95455A@FreeBSD.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sun, Jun 23, 2019 at 1:56 PM Glen Barber <gjb@freebsd.org> wrote: > FWIW, I don=E2=80=99t think =E2=80=9Ceither/or=E2=80=9D is necessarily th= e best approach; meaning > I would like to still keep the tag in the default template. > A while ago, I proposed a protocol that we'd only have the RELNOTES file. The other part of the protocol was to remove it from RELNOTES once it was added to the release notes. This way, we can have multiple people working on the release notes should we be so fortunate to have those resources in the future. It's minorly racy, but not terrible. This way, release notes text could also be written by the committer and tweaked by whomever compiles the release notes. However, I'm cool with having it in the commit message + template since it's better to have a heads up you need to write something than not. The understanding would be a RelNotes: yes would mean that someone else would write the notes and if you wanted to have more control over what went out, you'd use RELNOTES. Glen, do you think that's a workable protocol? Warner > Glen > (Who knows first hand how much it sucks going through commit logs for > relnotes entries) > Sent from my phone. > Please excuse my brevity and/or typos. > > > On Jun 23, 2019, at 3:49 PM, Glen Barber <gjb@freebsd.org> wrote: > > > > Yes, please. > > > > Glen > > Sent from my phone. > > Please excuse my brevity and/or typos. > > > >> On Jun 23, 2019, at 3:18 PM, Mark Johnston <markj@freebsd.org> wrote: > >> > >> Hi, > >> > >> Today we add a Relnotes tag to commits that warrant a release note. > >> My impression is that it doesn't work so well: if a committer forgets > >> or doesn't know to add one there's no way to amend the commit message > >> (same for MFCs), and a commit message isn't a convenient place to writ= e > >> the text of a release note. I would like to propose adding a top-leve= l > >> RELNOTES file instead, which like UPDATING would document notes for > >> specific commits. It would be truncated every time the head branch is > >> forked, and changes to it would be MFCed. This fixes the > >> above-mentioned problems and would hopefully reduce the amount of time > >> needed by re@ to compile release notes. > >> > >> For example: > >> > >> Index: RELNOTES > >> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > >> --- RELNOTES (nonexistent) > >> +++ RELNOTES (working copy) > >> @@ -0,0 +1,8 @@ > >> +Release notes for FreeBSD 13.0. > >> + > >> +r349286: > >> + swapon(8) can now erase a swap device immediately before > >> + enabling it, similar to newfs(8)'s -E option. This behaviour > >> + can be specified by adding -E to swapon(8)'s command-line > >> + parameters, or by adding the "trimonce" option to a swap > >> + device's /etc/fstab entry. > >> > >> What do folks think? > >> > > > > _______________________________________________ > freebsd-hackers@freebsd.org mailing list > https://lists.freebsd.org/mailman/listinfo/freebsd-hackers > To unsubscribe, send any mail to "freebsd-hackers-unsubscribe@freebsd.org= " >
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CANCZdfrvv9x3EyS=cgFQhKs6kNC9pnz5dnPziLbvYoyOT8UuZw>