From owner-freebsd-hackers@freebsd.org Mon Jun 24 15:41:22 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 3075115D0E9A for ; Mon, 24 Jun 2019 15:41:22 +0000 (UTC) (envelope-from cy.schubert@cschubert.com) Received: from smtp-out-no.shaw.ca (smtp-out-no.shaw.ca [64.59.134.13]) (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 DF25973173; Mon, 24 Jun 2019 15:41:20 +0000 (UTC) (envelope-from cy.schubert@cschubert.com) Received: from spqr.komquats.com ([70.67.125.17]) by shaw.ca with ESMTPA id fR5ohKkuDldkPfR5pheIgP; Mon, 24 Jun 2019 09:41:19 -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=n6k8NqbHqnZ7CfTDqAUA:9 a=QEXdDO2ut3YA:10 a=IjZwj45LgO3ly-622nXo:22 a=Ia-lj3WSrqcvXOmTRaiG:22 Received: from android-9b917f0ce39da6e6.esitwifi.local (S0106788a207e2972.gv.shawcable.net [70.66.154.233]) by spqr.komquats.com (Postfix) with ESMTPSA id 617E4AAA; Mon, 24 Jun 2019 08:41:15 -0700 (PDT) Date: Mon, 24 Jun 2019 07:57:02 -0700 User-Agent: K-9 Mail for Android In-Reply-To: <20190624003616.GA90409@raichu> References: <20190623191818.GA84365@raichu> <55030704-F521-4D6E-9B56-4B7F65EFFC38@FreeBSD.org> <20190624003616.GA90409@raichu> 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, Mark Johnston , "Bjoern A. Zeeb" CC: re@freebsd.org From: Cy Schubert Message-ID: <8FF694F5-D5FC-467E-ADBE-244C3A3254D2@cschubert.com> X-CMAE-Envelope: MS4wfFv+a11HJqwrLn5fel1rKPYbFGEWiPEIwNo+celwsrLqLnENo43eucffBRFkx51C3ytMjchVFAb2Z5rfHsbKjGV51dw3lAyPPJ2YmwjvmvHs1r9szHVL O6SSbvZajaMg2ty1kJwDQ9KWCoTHlj+xOpjE2iWYfAjeT//KjMqCVLlg5T/Eb+xx6xP7WSiBGGJC20mBuwJu4xBkEcx4UzNKccOq61EXaUUo1+Q11Bge7EOp wO5DUupeb8VkzwmO28DuuT6+7cUzc0A4GylU1z9c06M= X-Rspamd-Queue-Id: DF25973173 X-Spamd-Bar: ----- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-5.72 / 15.00]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; NEURAL_HAM_MEDIUM(-1.00)[-1.000,0]; FROM_HAS_DN(0.00)[]; RCPT_COUNT_THREE(0.00)[4]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; MIME_GOOD(-0.10)[text/plain]; RCVD_TLS_LAST(0.00)[]; NEURAL_HAM_LONG(-1.00)[-1.000,0]; RCVD_COUNT_THREE(0.00)[3]; IP_SCORE(-2.56)[ip: (-6.91), ipnet: 64.59.128.0/20(-3.27), asn: 6327(-2.54), country: CA(-0.09)]; MX_GOOD(-0.01)[cached: spqr.komquats.com]; NEURAL_HAM_SHORT(-0.95)[-0.948,0]; R_SPF_NA(0.00)[]; RCVD_IN_DNSWL_LOW(-0.10)[13.134.59.64.list.dnswl.org : 127.0.5.1]; R_DKIM_NA(0.00)[]; MIME_TRACE(0.00)[0:+]; RECEIVED_SPAMHAUS_PBL(0.00)[17.125.67.70.zen.spamhaus.org : 127.0.0.11,233.154.66.70.zen.spamhaus.org : 127.0.0.11]; ASN(0.00)[asn:6327, ipnet:64.59.128.0/20, country:CA]; MID_RHS_MATCH_FROM(0.00)[]; FROM_EQ_ENVFROM(0.00)[] 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 15:41:22 -0000 On June 23, 2019 5:36:16 PM PDT, Mark Johnston 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=20 >> > write >> > the text of a release note=2E I would like to propose adding a=20 >> > 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=20 >> people, and the docs people, and all other kinds of hats can put >things=20 >> in there as well? > >Virtually all of the 12=2E0 release notes are for src/ (there are 4 lines >for ports/pkg and 1 line for docs, and the latter describes a new man >page in src)=2E Why is it important to have a single place for everyone >to commit their entries? > >> Oh, the release notes go into the doc repo anyway=2E Can we just put >them=20 >> in the right place and just fill them from a skeleton where they >should=20 >> be and naturally grow the document (feel free to use a different >markup=20 >> language once doc is ready for that)=2E >>=20 >> Oh, with that release notes are written automatically and you are >still=20 >> responsible for that your stuff is in there=2E And the release notes >only=20 >> 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=20 >> just vanish as we=E2=80=99d have these updated at least every 10 minute= s=20 >> automatically =2E=2E on our web server under /releases/ where they belo= ng >=2E=2E >>=20 >> How amazing would that be? > >I would guess that many src committers simply won't add release notes >if >they have to commit to a second repository and use some unfamiliar >markup format and worry about validating the file=2E There are lots of >__FreeBSD_version bumps that go undocumented until someone else goes in >and fills in the missing entries=2E A plain-text file in src repo for >src >release notes is low-friction and creates only marginally more work for >RE=2E "What's cooking for 13?" can just point to the copy of RELNOTES in >svnweb=2E > >That said, I personally would try to commit my release notes to a doc >repo file if one existed=2E I've spent a few minutes trying to compile >the 12=2E0 notes on my desktop and have not been able to get past, >"cannot >parse http://www=2EFreeBSD=2Eorg/XML/share/xml/freebsd-xhtml-release=2Exs= l"=2E >So, I'm probably not a good person to set up release notes for 13=2E0=2E = I >will help fill in entries for commits since the 12=2E0 if someone else >does that setup=2E >_______________________________________________ >freebsd-hackers@freebsd=2Eorg mailing list >https://lists=2Efreebsd=2Eorg/mailman/listinfo/freebsd-hackers >To unsubscribe, send any mail to >"freebsd-hackers-unsubscribe@freebsd=2Eorg" Src and ports should each have their own RELNOTES file=2E The only operational concern I have is trimming the file, probably when a = branch goes EOL=2E --=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