Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 13 Apr 2022 12:37:31 -0500
From:      Mike Karels <mike@karels.net>
To:        Glen Barber <gjb@freebsd.org>
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:  <F9C09B18-21C6-4182-89BA-14EABEB69110@karels.net>
In-Reply-To: <20220413171237.GN28996@FreeBSD.org>
References:  <202204130133.23D1X0Hx031524@gitrepo.freebsd.org> <36b6607e-6a32-cfb0-06fc-ccafeb00409f@FreeBSD.org> <20220413171237.GN28996@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On 13 Apr 2022, at 12:12, Glen Barber wrote:

> 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."
>
> I do not think we have a strict rule on this, one way or the other.

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.

I=E2=80=99m willing to make another pass if there is consensus.

		Mike

> Glen



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?F9C09B18-21C6-4182-89BA-14EABEB69110>