From: Pedro Alves <palves@redhat.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Joel Brobecker <brobecker@adacore.com>,
binutils@sourceware.org, gdb-patches@sourceware.org
Subject: Re: small request regarding commits in binutils-gdb.git
Date: Wed, 15 Jan 2014 16:50:00 -0000 [thread overview]
Message-ID: <52D6BC37.9000806@redhat.com> (raw)
In-Reply-To: <83mwix44gh.fsf@gnu.org>
On 01/15/2014 04:03 PM, Eli Zaretskii wrote:
> The text before the log entry is just a long way of saying the same
> thing as the log entry, isn't it? It repeats the info that is already
> in the log entry. Why does it make sense to repeat all that?
Comments in the code should describe anything non-obvious about
the _present_ state of the code. ("We used to do this, and now
do that" comments are not appropriate in the code.) The ChangeLog
entry says _what_ changed. The rationale for the change, the _why_
the change was made, the bridge between old and new, is what is
often lost in the mailing list archives, often times spread over
a discussion crossing several emails (and if it crosses the month
border, it's usually harder even to retrieve), if in any at all.
The commit log is the perfect place to store that info.
--
Pedro Alves
next prev parent reply other threads:[~2014-01-15 16:50 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-01-15 12:12 Joel Brobecker
2014-01-15 15:28 ` Mike Frysinger
2014-01-15 15:51 ` Tom Tromey
2014-01-15 16:04 ` Eli Zaretskii
2014-01-15 16:25 ` Joel Brobecker
2014-01-15 16:57 ` Eli Zaretskii
2014-01-15 17:12 ` Mike Frysinger
2014-01-15 19:48 ` Fred Cooke
2014-01-15 20:02 ` Mike Frysinger
2014-01-15 20:38 ` Eli Zaretskii
2014-01-15 20:57 ` Mike Frysinger
2014-01-15 21:09 ` Eli Zaretskii
2014-01-16 2:11 ` Alan Modra
2014-01-16 2:17 ` Joel Brobecker
2014-01-16 1:41 ` Fred Cooke
2014-01-16 2:41 ` Mike Frysinger
2014-01-15 16:50 ` Pedro Alves [this message]
2014-01-15 17:03 ` Tom Tromey
2014-01-15 18:07 ` Gary Benson
2014-01-16 11:41 ` Jose E. Marchesi
2014-01-15 19:31 ` Cary Coutant
2014-01-15 19:45 ` Tom Tromey
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=52D6BC37.9000806@redhat.com \
--to=palves@redhat.com \
--cc=binutils@sourceware.org \
--cc=brobecker@adacore.com \
--cc=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
/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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox