Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 24 Jun 2019 15:57:37 +0200
From:      Baptiste Daroussin <bapt@FreeBSD.org>
To:        Mark Johnston <markj@freebsd.org>
Cc:        freebsd-hackers@freebsd.org, re@freebsd.org
Subject:   Re: release notes file
Message-ID:  <20190624135737.42mf3fi7q75xipsx@ivaldir.net>
In-Reply-To: <20190623191818.GA84365@raichu>
References:  <20190623191818.GA84365@raichu>

next in thread | previous in thread | raw e-mail | index | archive | help

--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--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20190624135737.42mf3fi7q75xipsx>