This is the mail archive of the
mailing list for the binutils project.
Re: small request regarding commits in binutils-gdb.git
- From: Pedro Alves <palves at redhat dot com>
- To: Eli Zaretskii <eliz at gnu dot org>
- Cc: Joel Brobecker <brobecker at adacore dot com>, binutils at sourceware dot org, gdb-patches at sourceware dot org
- Date: Wed, 15 Jan 2014 16:49:59 +0000
- Subject: Re: small request regarding commits in binutils-gdb.git
- Authentication-results: sourceware.org; auth=none
- References: <20140115121251 dot GM4639 at adacore dot com> <83mwix44gh dot fsf at gnu dot 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.