From owner-freebsd-hackers@freebsd.org Mon Jun 24 00:53:44 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 84B7815B8F3C for ; Mon, 24 Jun 2019 00:53:44 +0000 (UTC) (envelope-from freebsd-rwg@gndrsh.dnsmgr.net) Received: from gndrsh.dnsmgr.net (br1.CN84in.dnsmgr.net [69.59.192.140]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 75B0F76F14; Mon, 24 Jun 2019 00:53:43 +0000 (UTC) (envelope-from freebsd-rwg@gndrsh.dnsmgr.net) Received: from gndrsh.dnsmgr.net (localhost [127.0.0.1]) by gndrsh.dnsmgr.net (8.13.3/8.13.3) with ESMTP id x5O0rewK041294; Sun, 23 Jun 2019 17:53:40 -0700 (PDT) (envelope-from freebsd-rwg@gndrsh.dnsmgr.net) Received: (from freebsd-rwg@localhost) by gndrsh.dnsmgr.net (8.13.3/8.13.3/Submit) id x5O0rexU041293; Sun, 23 Jun 2019 17:53:40 -0700 (PDT) (envelope-from freebsd-rwg) From: "Rodney W. Grimes" Message-Id: <201906240053.x5O0rexU041293@gndrsh.dnsmgr.net> Subject: Re: release notes file In-Reply-To: <20190624003616.GA90409@raichu> To: Mark Johnston Date: Sun, 23 Jun 2019 17:53:40 -0700 (PDT) CC: "Bjoern A. Zeeb" , freebsd-hackers@freebsd.org, re@freebsd.org X-Mailer: ELM [version 2.4ME+ PL121h (25)] MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset=US-ASCII X-Rspamd-Queue-Id: 75B0F76F14 X-Spamd-Bar: ++ Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [2.15 / 15.00]; TO_DN_SOME(0.00)[]; RCVD_COUNT_THREE(0.00)[3]; MX_GOOD(-0.01)[cached: gndrsh.dnsmgr.net]; FROM_EQ_ENVFROM(0.00)[]; R_DKIM_NA(0.00)[]; MIME_TRACE(0.00)[0:+]; ASN(0.00)[asn:13868, ipnet:69.59.192.0/19, country:US]; MID_RHS_MATCH_FROM(0.00)[]; ARC_NA(0.00)[]; NEURAL_HAM_MEDIUM(-0.09)[-0.085,0]; FROM_HAS_DN(0.00)[]; RCPT_COUNT_THREE(0.00)[4]; TO_MATCH_ENVRCPT_ALL(0.00)[]; NEURAL_SPAM_SHORT(0.57)[0.569,0]; MIME_GOOD(-0.10)[text/plain]; RCVD_TLS_LAST(0.00)[]; DMARC_NA(0.00)[dnsmgr.net]; AUTH_NA(1.00)[]; IP_SCORE(0.04)[ip: (0.14), ipnet: 69.59.192.0/19(0.07), asn: 13868(0.05), country: US(-0.06)]; NEURAL_SPAM_LONG(0.74)[0.739,0]; R_SPF_NA(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 00:53:44 -0000 > On Sun, Jun 23, 2019 at 11:23:57PM +0000, Bjoern A. Zeeb wrote: > > On 23 Jun 2019, at 19:18, Mark Johnston wrote: > > > > Hi, > > > > > 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. > > > > Hooray. 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? > > Virtually all of the 12.0 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). Why is it important to have a single place for everyone > to commit their entries? I echo your concerns. > > Oh, the release notes go into the doc repo anyway. 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). > > > > Oh, with that release notes are written automatically and you are still > > responsible for that your stuff is in there. And the release notes only > > need an editing pass in the end? > > > > And the wiki pages like ?What?s cooking for 13?? or similar could > > just vanish as we?d have these updated at least every 10 minutes > > automatically .. on our web server under /releases/ where they belong .. > > > > 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. There are lots of > __FreeBSD_version bumps that go undocumented until someone else goes in > and fills in the missing entries. A plain-text file in src repo for src > release notes is low-friction and creates only marginally more work for > RE. "What's cooking for 13?" can just point to the copy of RELNOTES in > svnweb. Very much my position on the issue of a simple text file as src/RELNOTES, see other reply. > > That said, I personally would try to commit my release notes to a doc > repo file if one existed. I've spent a few minutes trying to compile > the 12.0 notes on my desktop and have not been able to get past, "cannot > parse http://www.FreeBSD.org/XML/share/xml/freebsd-xhtml-release.xsl". > So, I'm probably not a good person to set up release notes for 13.0. I > will help fill in entries for commits since the 12.0 if someone else > does that setup. Even having you do the simple text in the RELNOTES file is 90% of the work, formatting, markdown, whatever, lets let the doc experts deal with that. This would be a case where we could consistantly delivery a fair bit of simple text for them to work on, and it would take work load off RE@. -- Rod Grimes rgrimes@freebsd.org