From nobody Wed Apr 13 17:47:00 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 3B7421B39F1E for ; Wed, 13 Apr 2022 17:47:07 +0000 (UTC) (envelope-from gjb@freebsd.org) Received: from freefall.freebsd.org (freefall.freebsd.org [96.47.72.132]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "freefall.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4KdqmC19pcz55TD; Wed, 13 Apr 2022 17:47:07 +0000 (UTC) (envelope-from gjb@freebsd.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1649872027; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=T9QAAgJWjaruGNtQAmRf6XLndQJrG8mn3eE+uRhBVVM=; b=nRgqZqgmI80Jsok3Uty5Li5SUEI5Q4CQ3lc76KVcHfRuPnMJvd3YtcreAcFvtw7xhTpnFH zdGI+iyl8dpPhx3dP6q0Nz6g9JltWsKcV4XSMGaF2XqPC0S0ogpMNk77EswXUkpLt8IoOW QZHKfRLzH95DoGCre5aQcWmHgssg3hVGcW4tB0AMJItiobFywUPwDu9tchIYt3gZpm+r3k F+rlVOp8moeXoke3RuzD+4wuTZb/zFvWhcghKiuliUvasJkIg2nohIZF0kNBzgUsv0kCOa FUTZOf6B5ljIeAYbmDCtHKcad9y/AFvLiDUMMrKRX8eWysOauWvNi9r3GiwEUg== Received: from FreeBSD.org (freefall.freebsd.org [IPv6:2610:1c1:1:6074::16:84]) (using TLSv1 with cipher ECDHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by freefall.freebsd.org (Postfix) with ESMTPS id 99DBB6FD2; Wed, 13 Apr 2022 17:47:06 +0000 (UTC) (envelope-from gjb@freebsd.org) Date: Wed, 13 Apr 2022 17:47:00 +0000 From: Glen Barber To: Mike Karels Cc: John Baldwin , Mike Karels , 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> References: <202204130133.23D1X0Hx031524@gitrepo.freebsd.org> <36b6607e-6a32-cfb0-06fc-ccafeb00409f@FreeBSD.org> <20220413171237.GN28996@FreeBSD.org> List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="oJAv8lSwuaQsYd0G" Content-Disposition: inline In-Reply-To: ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1649872027; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=T9QAAgJWjaruGNtQAmRf6XLndQJrG8mn3eE+uRhBVVM=; b=PcjA0P0EKb9EOmpkBuWpHAga+zSotTbsB8cqbCRRuZ2u893ZP+IfQMrcRMUbuimOxztVBv TFYotbswVib1B4ovCcBg7f5+J74pllpUHsqRgnZp9EG84hwb5Z7TMsg7O1llLgIgQ1Tdzh FI0tOU0cTfPO6LgjUsZyj9FJzlYQvA769i4BYlWngFEJlfh+ocVjaE8JJGqQTVbQO5bMr9 cBhOLKaZmE4wBKUpOLpfqG0EFeRLdYuiE9tWHc+ivTcbcMa2zHkjnE68UjKUlGOYBGz88N GzNG3K6ydTaJR6PRkCCQ6ZRnIdvwcK5EkUJ3tWbj427NTQDGp62zBSdxwB75Pg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1649872027; a=rsa-sha256; cv=none; b=w+7FcOuy+u4ISNp3qIYUEw9K8XN2s5G6AWyQgyUhePSrLdvz2djOIqZzRBvfmfU3mKq0qA 8MbxmNf66pmA88e5rtgWHYTiUE3fDqjv5Dod0n8vX8oqguIOkg/LzUUF+WpqKhEmnEct8b 4FOG576KQx/etmZubig/lcgcPCsY3F3m689EJFT3qna98Jb34lx27SjEbFnGtziBUnEwz4 bbpUxaolbXD2FDBOMQlbau/NE205RQV+o0wwUf2icJD7SXiCXHPcenpOn2r8bnJ3q1JjQk n6nG0q9rUccXYXZcp5sAhvc4BLejtC9ZK68oqCAV5a0Rer0Y+FAL2TE9IKxpiQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N --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 > >>> AuthorDate: 2022-04-12 21:40:17 +0000 > >>> Commit: Mike Karels > >>> 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--