Date: Sun, 23 Jun 2019 23:48:45 +0000 From: Glen Barber <gjb@freebsd.org> To: "Bjoern A. Zeeb" <bz@freebsd.org> Cc: Mark Johnston <markj@freebsd.org>, freebsd-hackers@freebsd.org, re@freebsd.org Subject: Re: release notes file Message-ID: <20190623234845.GE41944@FreeBSD.org> In-Reply-To: <55030704-F521-4D6E-9B56-4B7F65EFFC38@FreeBSD.org> References: <20190623191818.GA84365@raichu> <55030704-F521-4D6E-9B56-4B7F65EFFC38@FreeBSD.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--BQPnanjtCNWHyqYD Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Sun, Jun 23, 2019 at 11:23:57PM +0000, Bjoern A. Zeeb wrote: > On 23 Jun 2019, at 19:18, Mark Johnston wrote: >=20 > Hi, >=20 > > 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 write > > the text of a release note. I would like to propose adding a top-level > > 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. >=20 > Hooray. Can we put that file into the doc repo, so that the ports people, > and the docs people, and all other kinds of hats can put things in there = as > well? >=20 > Oh, the release notes go into the doc repo anyway. Can we just put them = in > the right place and just fill them from a skeleton where they should be a= nd > naturally grow the document (feel free to use a different markup language > once doc is ready for that). >=20 > Oh, with that release notes are written automatically and you are still > responsible for that your stuff is in there. And the release notes only > need an editing pass in the end? >=20 > And the wiki pages like =E2=80=9CWhat=E2=80=99s cooking for 13?=E2=80=9D = or similar could just > vanish as we=E2=80=99d have these updated at least every 10 minutes autom= atically .. > on our web server under /releases/ where they belong .. >=20 > How amazing would that be? Very. But, I have one non-important nit -- the file in question does not need to be formatted for the documentation language of the day. In other words, I do not see this file as a "copy/paste from here to there and be done with it" sort of thing; i.e., grammar nits, clarifications that stray from the original commit log (or commit log intent), etc. When re@ requests clarification on commits or prods committers for things that may not have otherwise made it into the release notes, it isn't sent as a "please send us the properly-formatted XML entry" or some such thing, so personally, I am perfectly fine with a 80-character line-length raw plain-text entry. Just my $0.02 USD. Glen --BQPnanjtCNWHyqYD Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEjRJAPC5sqwhs9k2jAxRYpUeP4pMFAl0QD9gACgkQAxRYpUeP 4pMT6w//dWiB1FCvsEoV1XBA+0PrI2othlPjNuff/k0hprJKNzY+anD9UW9UBckL YrdUzF5xk9u78cEpzVQp4bysZcVqIA+QR1GAXVVnOVNFuDvaKqQXNe3r72Px4qsH r0q+2WVeU0MuFWLMoDT8XzRaXC02ERMBcGceBC8DbtpIvHPFChkgp7NSMfVlj5dW 0OhGPBBfe+87SS6V3RH5eSeAvpF9xV8bQSBEDCe+dQqfGuYqug9hFBgHh35v9leR SkvyEIY32+ErePYjZeCSaGLI+G5gpBBsrAfFSDgGcwVLEX2IpVAcCkQhrIe31XLs lTSjJSoSjFY9KTv71bWRhaCf/fIybLkCpbwREKkHQRO/5kF2uetz/xKVk3zaIxG3 sAn+ZpmTid7uEpHs2Wo/Pz9KTZMu40uvX2WH00Kha4P/p0MhtJSs5Io2N+65+C7u Az8fpsUEiRMyRaDmpdsTl6CVTJC8IwVbG6yhVELgY72W1unFeMokjKCK3VeD5SaI RXUvA6ID8ogUXALz9qIeGAH88A0ZqE5DIbF71HFQ8GVo8PLnc7tl+GN28kNQu4zQ ZnAvb7+ZxbNTZtoMgsSx0xpLVEqk3U+4njb355XJCBDmNiCyFatBMC4MwToeYmzw UvLypU/lVrywvu2EctzzxB4sjDfcn4oRyGZZ3Ks4TsyfcifLUBI= =NhaN -----END PGP SIGNATURE----- --BQPnanjtCNWHyqYD--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20190623234845.GE41944>