Date: Wed, 13 Apr 2022 17:47:00 +0000 From: Glen Barber <gjb@freebsd.org> To: Mike Karels <mike@karels.net> Cc: John Baldwin <jhb@freebsd.org>, Mike Karels <karels@freebsd.org>, doc-committers@freebsd.org, dev-commits-doc-all@freebsd.org Subject: Re: git: c4e48b65b7 - main - 13.1 relnotes: Change previous entries to avoid imperative. Message-ID: <20220413174700.GO28996@FreeBSD.org> In-Reply-To: <F9C09B18-21C6-4182-89BA-14EABEB69110@karels.net> References: <202204130133.23D1X0Hx031524@gitrepo.freebsd.org> <36b6607e-6a32-cfb0-06fc-ccafeb00409f@FreeBSD.org> <20220413171237.GN28996@FreeBSD.org> <F9C09B18-21C6-4182-89BA-14EABEB69110@karels.net>
next in thread | previous in thread | raw e-mail | index | archive | help
--oJAv8lSwuaQsYd0G Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, Apr 13, 2022 at 12:37:31PM -0500, Mike Karels wrote: > On 13 Apr 2022, at 12:12, Glen Barber wrote: >=20 > > On Wed, Apr 13, 2022 at 10:09:53AM -0700, John Baldwin wrote: > >> On 4/12/22 6:33 PM, Mike Karels wrote: > >>> The branch main has been updated by karels (src committer): > >>> > >>> URL: https://cgit.FreeBSD.org/doc/commit/?id=3Dc4e48b65b76ff0ae15de17= 969d152233eeac83c4 > >>> > >>> commit c4e48b65b76ff0ae15de17969d152233eeac83c4 > >>> Author: Mike Karels <karels@FreeBSD.org> > >>> AuthorDate: 2022-04-12 21:40:17 +0000 > >>> Commit: Mike Karels <karels@FreeBSD.org> > >>> CommitDate: 2022-04-13 01:32:44 +0000 > >>> > >>> 13.1 relnotes: Change previous entries to avoid imperative. > >>> Change previous entries from "Add ..." to "... has been added", > >>> etc, for consistency. > >>> Reviewed by: pauamma_gundo.com > >>> Differential Revision: https://reviews.freebsd.org/D34892 > >> > >> Hmm, for 13.0 we explicitly used active voice rather than passive. I = don't know > >> that we have a definitive style guide for release notes though. > >> > > > > For the past few releases, I have been using "... had been added." > > I personally have no complaint against using "... has been added." > > My apologies. I had this reversed. (See the 12.2-RELEASE notes for example.) > > I do not think we have a strict rule on this, one way or the other. >=20 > I checked the 13.0 version, and a lot of the entries are missing a subjec= t, > e.g. =E2=80=9CAdded ...=E2=80=9D and =E2=80=9CRemoved ...=E2=80=9D, which= are not really sentences. Some > of the 13.1 entries could be changed to active voice, but I=E2=80=99m not= sure what > to use for a subject for =E2=80=9Chas been fixed=E2=80=9D. >=20 I am inclined to think "[...] has been fixed", for example, referencing the 12.2 release notes again: % The ipfw(4) driver has been updated to support RFC6598/Carrier Grade % NAT subnets. In my opinion, "has been updated" and "has been fixed" are effectively the same thing. > I=E2=80=99m willing to make another pass if there is consensus. >=20 I think as long as we are consistent, there is no "right" or "wrong" way to document release notes. My $0.02 USD. Glen --oJAv8lSwuaQsYd0G Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEjRJAPC5sqwhs9k2jAxRYpUeP4pMFAmJXDJQACgkQAxRYpUeP 4pNPWw//SGl8/QbwY8OgwWTjjF22R7GFZAu54gz2470aud4SXoKu1aQ2IgpDyDEk 5dLE0bO3/miPsqqYHbYo9BSvCymxf1FYWnhtAZT/E0yARNyX3PBYYO6BfyHg7I8F 3CDB6vfYOrbwHr3LBxvjvzensho4IjV11PfTPa1CvjaI27pgoNd7mW8Xg+iy8knL 1CCUp0QoJWD+km3gg23mgl2UGgnp86IzMc6CV+CVy4Bj9JkM6OjnGO8H+ARq//LY m5s7B5lZzlpwYil7a3k1qvHYMj4zZMO6SqtDp6fVUZTT6X3yFpLUEKGlUFD1SGM/ Xddvo2f08Lhx2tw+9Bi7YtUzk/DNIJUecSxTtwPo5LmKkLdJ/8iENXoYrjZMnwm1 4GVu+zpACeMRXWhHqL3U8BicTOmSKRdRzFxLgsuXmbB7TVavG3iiZHiN2QFmshso /5+1/t6oPO1VJVUlA0JxAxNje/rIjQ5oR2eGWhu7TUs8UOj4jzgCzJYVOmQTVGmz Z/UrbuhGlycq8NoHzTKJkvzdFPvkT3DCfFvAbK4t/wd8NGQuepAoWnGOWWL9XLbf hOaS7hrONYn7gFL4F+s00MNEh/uKbFXdJD+WRv4fYArdlbKEd51sADfnNnKq1eAZ QFcasz04oAD5iDijG7ilM0ZekNTpEqMiPG/NJorR5h/jOnv1XPo= =v2Pj -----END PGP SIGNATURE----- --oJAv8lSwuaQsYd0G--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20220413174700.GO28996>