From owner-freebsd-hackers@freebsd.org Mon Jun 24 13:50:56 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 54F5215CDF09 for ; Mon, 24 Jun 2019 13:50:56 +0000 (UTC) (envelope-from cy.schubert@cschubert.com) Received: from smtp-out-no.shaw.ca (smtp-out-no.shaw.ca [64.59.134.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "Client", Issuer "CA" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 590C16EEB1; Mon, 24 Jun 2019 13:50:55 +0000 (UTC) (envelope-from cy.schubert@cschubert.com) Received: from spqr.komquats.com ([70.67.125.17]) by shaw.ca with ESMTPA id fPMyhK3wDldkPfPMzhdw0k; Mon, 24 Jun 2019 07:50:54 -0600 X-Authority-Analysis: v=2.3 cv=Ko4zJleN c=1 sm=1 tr=0 a=VFtTW3WuZNDh6VkGe7fA3g==:117 a=VFtTW3WuZNDh6VkGe7fA3g==:17 a=jpOVt7BSZ2e4Z31A5e1TngXxSK0=:19 a=IkcTkHD0fZMA:10 a=dq6fvYVFJ5YA:10 a=6I5d2MoRAAAA:8 a=YxBL1-UpAAAA:8 a=og3l_TXpHuICnghziWYA:9 a=u1WIcz-ICccVuO1L:21 a=CdI4npqxOCyQYX9Q:21 a=QEXdDO2ut3YA:10 a=IjZwj45LgO3ly-622nXo:22 a=Ia-lj3WSrqcvXOmTRaiG:22 Received: from [10.225.247.173] (unknown [24.244.23.146]) by spqr.komquats.com (Postfix) with ESMTPSA id 43810987; Mon, 24 Jun 2019 06:50:52 -0700 (PDT) Date: Mon, 24 Jun 2019 06:50:26 -0700 User-Agent: K-9 Mail for Android In-Reply-To: <20190623234845.GE41944@FreeBSD.org> References: <20190623191818.GA84365@raichu> <55030704-F521-4D6E-9B56-4B7F65EFFC38@FreeBSD.org> <20190623234845.GE41944@FreeBSD.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Subject: Re: release notes file To: freebsd-hackers@freebsd.org, Glen Barber , "Bjoern A. Zeeb" CC: Mark Johnston ,re@freebsd.org From: Cy Schubert Message-ID: <7802C1A1-8E79-40F1-9253-CA0E632EAD2B@cschubert.com> X-CMAE-Envelope: MS4wfNYfpfsC3PJWFlQFB4ijoumso+qnUfHFc3T+UezK56NPeyVF70lUDLvJ09sDU/WMffy7oKHn89grmQVG+XU5SklKQtVEGhgzJlPCZ+sNgo7w67Rb7K3P gdmlgxxEpMtJC1W/3g1/z3M1+q7G3tfxHGXPKgZP03aOg9udk91twmwNK6YBnaC8fq/v/nA6KkQ9SWzsi11a1Yg8NEWhrYUcUh8ybvKbZXd7h2MHxn2Z9kmB hPT2S2vRwQpshmmWrkXABPMfcp2+Xr59HCmWL3pvmF5XGkt7oLu5N8/yFpH+Eoh6 X-Rspamd-Queue-Id: 590C16EEB1 X-Spamd-Bar: ----- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-5.73 / 15.00]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; RECEIVED_SPAMHAUS_PBL(0.00)[17.125.67.70.zen.spamhaus.org : 127.0.0.11]; FROM_HAS_DN(0.00)[]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; NEURAL_HAM_LONG(-1.00)[-1.000,0]; MIME_GOOD(-0.10)[text/plain]; RCVD_TLS_LAST(0.00)[]; NEURAL_HAM_MEDIUM(-1.00)[-1.000,0]; RCPT_COUNT_FIVE(0.00)[5]; RCVD_COUNT_THREE(0.00)[3]; IP_SCORE(-2.55)[ip: (-6.87), ipnet: 64.59.128.0/20(-3.27), asn: 6327(-2.53), country: CA(-0.09)]; MX_GOOD(-0.01)[cached: spqr.komquats.com]; NEURAL_HAM_SHORT(-0.96)[-0.964,0]; R_SPF_NA(0.00)[]; FROM_EQ_ENVFROM(0.00)[]; R_DKIM_NA(0.00)[]; MIME_TRACE(0.00)[0:+]; ASN(0.00)[asn:6327, ipnet:64.59.128.0/20, country:CA]; MID_RHS_MATCH_FROM(0.00)[]; RCVD_IN_DNSWL_LOW(-0.10)[12.134.59.64.list.dnswl.org : 127.0.5.1] 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:50:56 -0000 On June 23, 2019 4:48:45 PM PDT, Glen Barber wrote: >On Sun, Jun 23, 2019 at 11:23:57PM +0000, Bjoern A=2E Zeeb wrote: >> On 23 Jun 2019, at 19:18, Mark Johnston wrote: >>=20 >> Hi, >>=20 >> > Today we add a Relnotes tag to commits that warrant a release note=2E >> > 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=2E I would like to propose adding a >top-level >> > RELNOTES file instead, which like UPDATING would document notes for >> > specific commits=2E It would be truncated every time the head branch >is >> > forked, and changes to it would be MFCed=2E This fixes the >> > above-mentioned problems and would hopefully reduce the amount of >time >> > needed by re@ to compile release notes=2E >>=20 >> Hooray=2E Can we put that file into the doc repo, so that the ports >people, >> and the docs people, and all other kinds of hats can put things in >there as >> well? >>=20 >> Oh, the release notes go into the doc repo anyway=2E Can we just put >them in >> the right place and just fill them from a skeleton where they should >be and >> naturally grow the document (feel free to use a different markup >language >> once doc is ready for that)=2E >>=20 >> Oh, with that release notes are written automatically and you are >still >> responsible for that your stuff is in there=2E And the release notes >only >> need an editing pass in the end? >>=20 >> And the wiki pages like =E2=80=9CWhat=E2=80=99s cooking for 13?=E2=80= =9D or similar could >just >> vanish as we=E2=80=99d have these updated at least every 10 minutes >automatically =2E=2E >> on our web server under /releases/ where they belong =2E=2E >>=20 >> How amazing would that be? > >Very=2E > >But, I have one non-important nit -- the file in question does not need >to be formatted for the documentation language of the day=2E In other >words, I do not see this file as a "copy/paste from here to there and >be >done with it" sort of thing; i=2Ee=2E, grammar nits, clarifications that >stray from the original commit log (or commit log intent), etc=2E > >When re@ requests clarification on commits or prods committers for >things that may not have otherwise made it into the release notes, it >isn't sent as a "please send us the properly-formatted XML entry" or >some such thing, so personally, I am perfectly fine with a 80-character >line-length raw plain-text entry=2E > >Just my $0=2E02 USD=2E > >Glen I disagree=2E It should be a =2Emd file to display properly on github=2E= =20 --=20 Pardon the typos and autocorrect, small keyboard in use=2E Cheers, Cy Schubert FreeBSD UNIX: Web: http://www=2EFreeBSD=2Eorg The need of the many outweighs the greed of the few=2E