From owner-freebsd-hackers@freebsd.org Mon Jun 24 13:57:39 2019 Return-Path: Delivered-To: freebsd-hackers@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 3D6CF15CE206 for ; Mon, 24 Jun 2019 13:57:39 +0000 (UTC) (envelope-from bapt@FreeBSD.org) Received: from smtp.freebsd.org (smtp.freebsd.org [IPv6:2610:1c1:1:606c::24b:4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "smtp.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id D87736F496; Mon, 24 Jun 2019 13:57:38 +0000 (UTC) (envelope-from bapt@FreeBSD.org) Received: from ivaldir.etoilebsd.net (etoilebsd.net [178.32.217.76]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) (Authenticated sender: bapt) by smtp.freebsd.org (Postfix) with ESMTPSA id 924F672EA; Mon, 24 Jun 2019 13:57:38 +0000 (UTC) (envelope-from bapt@FreeBSD.org) Received: by ivaldir.etoilebsd.net (Postfix, from userid 1001) id 966CDB6EA4; Mon, 24 Jun 2019 15:57:37 +0200 (CEST) Date: Mon, 24 Jun 2019 15:57:37 +0200 From: Baptiste Daroussin To: Mark Johnston Cc: freebsd-hackers@freebsd.org, re@freebsd.org Subject: Re: release notes file Message-ID: <20190624135737.42mf3fi7q75xipsx@ivaldir.net> References: <20190623191818.GA84365@raichu> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="chvxchzn52lstko7" Content-Disposition: inline In-Reply-To: <20190623191818.GA84365@raichu> User-Agent: NeoMutt/20180716 X-Rspamd-Queue-Id: D87736F496 X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.98 / 15.00]; local_wl_from(0.00)[FreeBSD.org]; NEURAL_HAM_MEDIUM(-1.00)[-0.999,0]; NEURAL_HAM_LONG(-1.00)[-1.000,0]; NEURAL_HAM_SHORT(-0.98)[-0.979,0]; ASN(0.00)[asn:11403, ipnet:2610:1c1:1::/48, country:US] X-BeenThere: freebsd-hackers@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Technical Discussions relating to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 24 Jun 2019 13:57:39 -0000 --chvxchzn52lstko7 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Sun, Jun 23, 2019 at 03:18:18PM -0400, Mark Johnston wrote: > 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 > For example: >=20 > 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. >=20 > What do folks think? I do like this idea, and maybe it should be made in a parseable format, so = that it can serve to create some messages to display while running pkg upgrade (= for pkgbase). pkg knows to only print message when going from a given revision of a packa= ge to another (and only in this case) to avoid having too many noise to the outpu= t. I think it would be a nice feature for pkgbase :) Bapt --chvxchzn52lstko7 Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEgOTj3suS2urGXVU3Y4mL3PG3PloFAl0Q1s8ACgkQY4mL3PG3 PlqEkxAAroHAVOQ3QQX/PYh5N4zdVhgesT9S23cGGvwXgLk5VWoG3q3Tvbg/V0c/ utdIRgJrSGd96/U3roQmOK8LtWR144zdLQCwUDPe5JUBwUFAHGL+KlOW8K9tAPbJ ++bN+UxxBk9KCGYRiCBUOkm+OJz25I1AaIEqj/t0zHkoYh7H23lVz/0gRs61FZ9s plPpmosTmZPEd6fju07TkBoa/lA4WtK8wGqD2iQF6SLCbuFIcBDqwR2PQQZSwJ+C RiEd2I0R7UlU4i3x98zMUCF5mo6OdEa7U/BzfJQFtrlj6qxCF3WYLKijtBJDWBLk D98/ocy/MelHwxticUOiQgBtBLCefP0YRA0l6B52uZHkUh+YANPCnpKL8Kn945ls Lef6KW7V+tPuwg+5cGWRuybUySGKndQHHGu38tAvXvHSKHbWi0bpILg1MQIn2sly okZ1pubqcs7yzD/6zuohXbQ21NJdqOJUq36t8Z0EcOZWP+xi8zaZzU2nXr10GqFI r8mO/DmA6v0cUmFqRvYYqEWIDhTMa0YU9STIwcB98ZyTArHsUNXIJWVLLaCZStrk H2gRVJgjjwVyVp0/ePLZIo0OLQP0poGrQCkpKYwXNfpgeRt5pP2C46rHgPLJsF8o baZuE0ovS4IblczeA7D1T6K3WafVBpo/ETktgnz36S5Ff77NyXY= =iA1L -----END PGP SIGNATURE----- --chvxchzn52lstko7--