From: Mark H Weaver <mhw@netris.org>
To: John Darrington <john@darrington.wattle.id.au>
Cc: guix-devel <guix-devel@gnu.org>
Subject: Re: [PATCH 4/6] gnu: linux-libre-beagle-bone-black: Remove kernel variant.
Date: Tue, 27 Sep 2016 20:14:38 -0400 [thread overview]
Message-ID: <8760pgubgx.fsf@netris.org> (raw)
In-Reply-To: <20160926164934.GA25011@jocasta.intra> (John Darrington's message of "Mon, 26 Sep 2016 18:49:34 +0200")
John Darrington <john@darrington.wattle.id.au> writes:
> On Mon, Sep 26, 2016 at 04:24:10PM +0200, Vincent Legoll wrote:
> Hello,
>
> @David: the following question is nothing against you, I just
> took the opportunity to ask, sorry for the thread hijacking.
>
> On Mon, Sep 26, 2016 at 3:23 PM, John Darrington wrote:
> > Why are we removing this?
>
> Is it just me finding this changelog format usefulness to be
> very low ?
>
>
> I entirely agree.
>
> Our current convention for commit messages is aesthetically pleasing,
> but useless. It is redundant to put in the message WHAT has changed.
> That can be easily determined by running "git show". What is much
> more usefull is the reason WHY we changed it.
>
>
> Recently, on another project, I came across a line of code which I
> was pretty sure was pointless. I was about to delete it - but I
> decided to check first. So I ran "git blame" to find out which
> commit had added it. Then I ran git show to get the full details
> of that commit. Fortunately, the person who had committed it 5 years
> ago had mentioned exactly why it was needed.
Our conventions for commit logs, which follow the GNU Coding Standards
for Change Logs (see section 6.8 of the GNU Coding Standards), is that
explanations belong in the comments of the code itself, not in the
commit log. If that had been done in the example you give above, you
would have known why the line was needed in a small fraction of the time
that it must have taken you to perform all the steps above.
However, I agree that commits that _remove_ code should include the
rationale in the commit log, if the reason is not obvious and if there's
no sensible place to put the explanation in the code.
What do you think?
Mark
next prev parent reply other threads:[~2016-09-28 0:14 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-26 10:34 [PATCH 1/6] gnu: Add picocom David Craven
2016-09-26 10:34 ` [PATCH 2/6] gnu: %default-extra-linux-options: Remove redundant options David Craven
2016-09-29 8:40 ` Ludovic Courtès
2016-09-29 8:53 ` David Craven
2016-09-29 10:33 ` David Craven
2016-09-29 12:35 ` Ludovic Courtès
2016-09-26 10:34 ` [PATCH 3/6] gnu: make-linux-libre: Install device tree files David Craven
2016-09-26 10:34 ` [PATCH 4/6] gnu: linux-libre-beagle-bone-black: Remove kernel variant David Craven
2016-09-26 13:23 ` John Darrington
2016-09-26 13:25 ` David Craven
2016-09-26 14:24 ` Vincent Legoll
2016-09-26 15:57 ` Ricardo Wurmus
2016-09-26 16:49 ` John Darrington
2016-09-26 16:57 ` Vincent Legoll
2016-09-26 17:31 ` Leo Famulari
2016-09-26 18:00 ` John Darrington
2016-09-26 18:06 ` David Craven
2016-09-26 18:22 ` Vincent Legoll
2016-09-26 18:28 ` David Craven
2016-09-26 18:34 ` Leo Famulari
2016-09-28 21:13 ` Ludovic Courtès
2016-09-27 10:47 ` Tobias Geerinckx-Rice
2016-09-28 0:14 ` Mark H Weaver [this message]
2016-09-28 6:16 ` John Darrington
2016-09-28 21:15 ` Ludovic Courtès
2016-09-28 21:11 ` Ludovic Courtès
2016-10-03 12:49 ` Vincent Legoll
2016-10-03 15:40 ` Ludovic Courtès
2016-10-04 14:32 ` Vincent Legoll
2016-09-26 10:34 ` [PATCH 5/6] gnu: make-u-boot-package: Add files-to-install argument David Craven
2016-09-26 12:39 ` Danny Milosavljevic
2016-09-26 13:38 ` David Craven
2016-09-26 13:41 ` David Craven
2016-09-26 14:04 ` Danny Milosavljevic
2016-09-26 14:07 ` David Craven
2016-09-26 22:28 ` Danny Milosavljevic
2016-10-07 8:19 ` David Craven
2016-10-07 9:26 ` Danny Milosavljevic
2016-09-26 10:34 ` [PATCH 6/6] gnu: make-u-boot-package: Don't cross compile on arm David Craven
2016-09-26 17:24 ` [PATCH 1/6] gnu: Add picocom Leo Famulari
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8760pgubgx.fsf@netris.org \
--to=mhw@netris.org \
--cc=guix-devel@gnu.org \
--cc=john@darrington.wattle.id.au \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).