From owner-freebsd-hackers@freebsd.org Thu Apr 14 03:48:07 2016 Return-Path: Delivered-To: freebsd-hackers@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 4303BB0F1B8 for ; Thu, 14 Apr 2016 03:48:07 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:1900:2254:206c::16:87]) by mx1.freebsd.org (Postfix) with ESMTP id 3292D1E1F; Thu, 14 Apr 2016 03:48:07 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Received: from FreeBSD.org (freefall.freebsd.org [IPv6:2001:1900:2254:206c::16:87]) by freefall.freebsd.org (Postfix) with ESMTP id D94731A87; Thu, 14 Apr 2016 03:48:06 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Date: Thu, 14 Apr 2016 03:48:05 +0000 From: Glen Barber To: "O'Connor, Daniel" Cc: Ngie Cooper , FreeBSD Hackers Subject: Re: Improving commit logs Message-ID: <20160414034805.GR18163@FreeBSD.org> References: <56FF6534-276E-4E52-871F-5567BD9D6EC7@dons.net.au> <20160414032801.GP18163@FreeBSD.org> <1DDB0BFB-545F-4293-9BFB-020DAFD7A5C4@dons.net.au> <20160414034320.GQ18163@FreeBSD.org> <2FD1641C-DF99-4464-BA34-A05430D663C4@dons.net.au> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="MRBOAUz+O/XNC2GI" Content-Disposition: inline In-Reply-To: <2FD1641C-DF99-4464-BA34-A05430D663C4@dons.net.au> X-Operating-System: FreeBSD 11.0-CURRENT amd64 X-SCUD-Definition: Sudden Completely Unexpected Dataloss X-SULE-Definition: Sudden Unexpected Learning Event X-PEKBAC-Definition: Problem Exists, Keyboard Between Admin/Computer User-Agent: Mutt/1.5.24 (2015-08-30) X-BeenThere: freebsd-hackers@freebsd.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: Technical Discussions relating to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 14 Apr 2016 03:48:07 -0000 --MRBOAUz+O/XNC2GI Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Apr 14, 2016 at 01:14:46PM +0930, O'Connor, Daniel wrote: >=20 > > On 14 Apr 2016, at 13:13, Glen Barber wrote: > > I absolutely agree with you that a guide on this will be beneficial. > > Sorry if my reply was taken any other way. > >=20 > > If I had a genie in a bottle, my three wishes would be: > >=20 > > 1) Better commit messages that address the "what"; > > 2) Better explanation on the "why"; >=20 > Huh interesting, I definitely would pick 2 before 1 but I can see > what you mean for a lot of commits (especially to 30 year old cruft > filled esoterica) >=20 When writing release notes, for example, the "what" is generally more useful than the "why." In other words, the end user does not generally care *why* something changed, but they want to know *what* changed. > > 3) More wishes. >=20 > You wish for more genies, wishing for more wishes is usually > verboten.. ;) >=20 I also want a pony. :) Glen --MRBOAUz+O/XNC2GI Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQIcBAEBCAAGBQJXDxL1AAoJEAMUWKVHj+KT75wP+QHT9pOHmOBlD2RSKILOf6tB 5/duvJ+rVBKp9A85Mqd4hNjYvfPPRtRZi7QeXjQw1E5FDIpIkYjNbJsZkI6QeIG6 LHX7COz4rgCjkWAz3fHahtR+SyGqr3LOzjv6ttumwrxeymjVHkBsEoCILDpyw+Z4 Xnu8n/zWzr7ehgBHgIlW7hcZVTfX2J3yEKJMEDqzqNQgq+rxZOe90Vo1tTeokOWS gugGYMjiAnZh3jywdJg11PV90NBIEE6rUNeZzuiVO/Myi+SMh6URjd393bjbtC+a VFgOPClP6HR7iIu6QdawrR5S2wjGI0K+vHIRADZSr7egKgjlHVlisYabBfiDbcq/ Prw0GIp5pp5FlRg/dKpBr17yM1gJHfc3j1h3Oq6dxWcWkInYbpNFgLFwVEqAB4Z1 6SKuzPKZN/2wYSC367QHpyzeFAaQsf88U3J8dQUB7AWLwUyU9KttXvYUM5RTY6Gy 1ytiJStMT/rwDf92yDOqr3m40E8GP5Pwz83VGeLIGa5lS+3lmZRDjTuP2aRfdzZW MYXvUkPcKlXqpQE9uy7CLHK+a4/7h2Pd28+LdZRzH+z9w3QkZ4V7l7mcKcxOdHMy yEojeLuZBmIQ+6Lu+M3ixWrg5ABaPTk3OaFk5O8+kfM/t3eKNR9kAUKPZrsgbIj2 DEZV/SolLRnRa9Iq0eAO =PlOL -----END PGP SIGNATURE----- --MRBOAUz+O/XNC2GI--