This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: Rant about ChangeLog entries and commit messages
- From: Andreas Schwab <schwab at suse dot de>
- To: Samuel Tardieu <sam at rfc1149 dot net>
- Cc: gcc at gcc dot gnu dot org
- Date: Sun, 02 Dec 2007 11:23:30 +0100
- Subject: Re: Rant about ChangeLog entries and commit messages
- References: <2007-12-02-11-05-39+trackit+sam@rfc1149.net>
Samuel Tardieu <sam@rfc1149.net> writes:
> As a recent committer to GCC, I am always surprised to see the content
> of ChangeLog entries and commit messages.
>
> I tend to find GCC ChangeLog entries useless. For example, the more
> recent ChangeLog entry in gcc/ChangeLog is:
>
> | 2007-11-30 Jan Hubicka <jh@suse.cz>
> |
> | * ggc-common.c (dump_ggc_loc_statistics): Reset ggc_force_collect
> | flag.
>
> How could a newcomer guess why the gcc_force_collect flag needs to be
> reset?
That is supposed to be written in a comment. The change log entry
should describe _what_ is being changed, so that you can find out when a
particular change was made.
Andreas.
--
Andreas Schwab, SuSE Labs, schwab@suse.de
SuSE Linux Products GmbH, Maxfeldstraße 5, 90409 Nürnberg, Germany
PGP key fingerprint = 58CA 54C7 6D53 942B 1756 01D3 44D5 214B 8276 4ED5
"And now for something completely different."