From owner-freebsd-hackers@freebsd.org Tue Jun 25 06:34:32 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 CA62B15C23B7 for ; Tue, 25 Jun 2019 06:34:31 +0000 (UTC) (envelope-from bapt@freebsd.org) Received: from smtp.freebsd.org (smtp.freebsd.org [96.47.72.83]) (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 70348742AB; Tue, 25 Jun 2019 06:34:31 +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 04BF1E8AD; Tue, 25 Jun 2019 06:34:31 +0000 (UTC) (envelope-from bapt@freebsd.org) Received: by ivaldir.etoilebsd.net (Postfix, from userid 1001) id DACB7B71AC; Tue, 25 Jun 2019 08:34:29 +0200 (CEST) Date: Tue, 25 Jun 2019 08:34:29 +0200 From: Baptiste Daroussin To: Mark Johnston Cc: freebsd-hackers@freebsd.org, re@freebsd.org Subject: Re: release notes file Message-ID: <20190625063429.r7ed72mutrytv4tb@ivaldir.net> References: <20190623191818.GA84365@raichu> <20190624135737.42mf3fi7q75xipsx@ivaldir.net> <20190624175211.GA66843@raichu> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="wu6mcrkjoufeeba3" Content-Disposition: inline In-Reply-To: <20190624175211.GA66843@raichu> User-Agent: NeoMutt/20180716 X-Rspamd-Queue-Id: 70348742AB X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.97 / 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.97)[-0.972,0]; ASN(0.00)[asn:11403, ipnet:96.47.64.0/20, 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: Tue, 25 Jun 2019 06:34:32 -0000 --wu6mcrkjoufeeba3 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Mon, Jun 24, 2019 at 01:52:11PM -0400, Mark Johnston wrote: > On Mon, Jun 24, 2019 at 03:57:37PM +0200, Baptiste Daroussin wrote: > > 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 wri= te > > > the text of a release note. I would like to propose adding a top-lev= el > > > 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? > >=20 > > 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 upgra= de (for > > pkgbase). > >=20 > > pkg knows to only print message when going from a given revision of a p= ackage to > > another (and only in this case) to avoid having too many noise to the o= utput. >=20 > Can you explain a bit further? I'm only familiar with pkg-message, > which is unstructured and always printed AFAIK. Since pkg 1.11 messages can be written in a structured format, see: https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/pkg-file= s.html#porting-message I am not asking for RELNOTES to be in the same format but something that ca= n be parsable with awk(1) for example and transformed into ucl base pkg-messages would be imho useful for adding messages to pkgbase. Best regards, Bapt --wu6mcrkjoufeeba3 Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEgOTj3suS2urGXVU3Y4mL3PG3PloFAl0RwHMACgkQY4mL3PG3 Plo1zg//RrGzHryml/ReVLLGwL+P/Jua5IFRFq1Kvg3Y1wmWqbMnu2i3Y3Q9DrsT bO2ONpgMaEDEjNi1VYB07CGA/n8+AFX4q/FqYAu358QbXPmKFE3q4NvJpTt3b0ma i5T/EHKewRqfJjy6E65G12Vv7iXpRF+Wo3HuxPm6wJ/vc9QLlTJCVpnRZjQlzT05 bFjxp6Pk//WV+ZlFv+O94Gx0AIBc0FLbrWaKmd6/Q9MjkYQ5wV1G+Bob+mowle5I z+YGmDlYkzoSesJzFoGF5aGsekeJbi1eoszGdWPPu7MbUF1TVz33kaf9vcQM+g+Y 7zMYG2ND/go6Lk+LjXscZtcAi6tJXjE+wyChWNDVDioAsalEyaAZBGLEc/PBd8YN pPD+lEo/iVUzgJj8wRzwhkzjhHTmlKB11W/VDMTCpuLNwORj9097NFEzmJeWmbwM 2g2+3UURboWSYAciSNeHjNMNgGQHq7AbbAsJCDs2l/UQUuEzUf0lP/auRVOtOZ06 OlxS2EvAaau8CXyKUO5tivPQEX2bGe2n04/iUov1QERJ5P/pabT8RXUMgag9jgxm HT37e66qH5QzqTA3SIRPez1Za6ddkbi51Vj4yFOUUkOvJNL1FlukJu//1FuJ3F98 PIMVeZuPhSaqzTkv8DZzbDz1RUGQXTELU3RBSBhqspfp3jNP0uA= =h5WY -----END PGP SIGNATURE----- --wu6mcrkjoufeeba3--