From: Nicholas Nethercote <njn@csse.unimelb.edu.au>
To: Andreas Schwab <schwab@suse.de>
Cc: Samuel Tardieu <sam@rfc1149.net>, gcc@gcc.gnu.org
Subject: Re: Rant about ChangeLog entries and commit messages
Date: Mon, 03 Dec 2007 06:45:00 -0000 [thread overview]
Message-ID: <Pine.GSO.4.61.0712031739500.10932@mulga.csse.unimelb.edu.au> (raw)
In-Reply-To: <jeodd9l7j1.fsf@sykes.suse.de>
On Sun, 2 Dec 2007, Andreas Schwab wrote:
>> | 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.
Indeed. Some advice I once wrote: Often I see a commit with a log message
that lovingly explains a small change made to fix a subtle problem, but adds
no comments to the code. Don't do this! Put that careful description in a
comment, where people can actually see it. (Commit logs are basically
invisible; even if they are auto-emailed to all developers, they are soon
forgotten, and they don't benefit people not on the email list.) That
comment is not a blemish but an invaluable record of an unusual case that
someone didn't anticipate. If the bug-fix was pre-empted by a lengthy email
exchange, include some or all of that exchange if it helps.
Nick
next prev parent reply other threads:[~2007-12-03 6:45 UTC|newest]
Thread overview: 79+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-12-02 10:05 Samuel Tardieu
2007-12-02 10:23 ` Andreas Schwab
2007-12-02 10:52 ` Samuel Tardieu
2007-12-02 12:04 ` Hans-Peter Nilsson
2007-12-02 23:28 ` Robert Dewar
2007-12-03 0:30 ` DJ Delorie
2007-12-03 4:06 ` Richard Kenner
2007-12-03 4:51 ` Daniel Berlin
2007-12-03 14:41 ` Richard Kenner
2007-12-02 11:43 ` Samuel Tardieu
2007-12-02 12:28 ` Richard Kenner
2007-12-02 12:43 ` Bernd Schmidt
2007-12-02 13:05 ` Eric Botcazou
2007-12-02 14:27 ` Robert Kiesling
2007-12-02 20:52 ` tim
2007-12-03 2:41 ` Robert Kiesling
2007-12-02 23:29 ` Robert Dewar
2007-12-02 20:28 ` Daniel Berlin
2007-12-02 20:36 ` Eric Botcazou
2007-12-02 20:40 ` Daniel Berlin
2007-12-02 22:55 ` Eric Botcazou
2007-12-03 0:21 ` Daniel Berlin
2007-12-03 6:16 ` Eric Botcazou
2007-12-03 13:29 ` Richard Kenner
2007-12-03 15:48 ` Daniel Berlin
2007-12-03 16:20 ` Richard Kenner
2007-12-03 16:50 ` Robert Kiesling
2007-12-03 17:26 ` Robert Dewar
2007-12-04 22:10 ` Jeffrey Law
2007-12-16 3:03 ` Alexandre Oliva
2007-12-16 10:25 ` NightStrike
2007-12-16 13:04 ` Alexandre Oliva
2007-12-16 18:52 ` NightStrike
2007-12-25 19:35 ` Tim Josling
2007-12-26 1:05 ` Daniel Berlin
2007-12-26 2:17 ` Richard Kenner
2007-12-26 2:31 ` Robert Dewar
2007-12-26 4:53 ` Richard Kenner
2007-12-26 6:00 ` Alexandre Oliva
2007-12-02 20:59 ` tim
2007-12-02 23:32 ` Robert Dewar
2007-12-03 6:02 ` Eric Botcazou
2007-12-03 3:55 ` Richard Kenner
2007-12-02 23:31 ` Joseph S. Myers
2007-12-02 20:23 ` Daniel Berlin
2007-12-03 6:45 ` Nicholas Nethercote [this message]
2007-12-03 9:28 ` Andreas Schwab
2007-12-02 10:27 ` Eric Botcazou
2007-12-02 10:43 ` Samuel Tardieu
2007-12-02 10:50 ` Eric Botcazou
2007-12-02 11:14 ` Samuel Tardieu
2007-12-02 11:32 ` Eric Botcazou
2007-12-02 11:48 ` Samuel Tardieu
2007-12-02 12:25 ` Eric Botcazou
2007-12-02 23:03 ` Ben Elliston
2007-12-02 23:54 ` Daniel Jacobowitz
2007-12-03 4:03 ` Richard Kenner
2007-12-03 17:33 ` Diego Novillo
2007-12-03 17:37 ` Richard Kenner
2007-12-03 17:47 ` Bernd Schmidt
2007-12-03 17:58 ` Ian Lance Taylor
2007-12-03 18:20 ` Diego Novillo
2007-12-03 18:51 ` Richard Kenner
2007-12-03 18:58 ` Diego Novillo
2007-12-03 20:08 ` Tim Josling
2007-12-03 18:49 ` Richard Kenner
2007-12-04 16:45 ` Tom Tromey
2007-12-05 23:16 ` Ben Elliston
2007-12-05 23:35 ` Daniel Berlin
2007-12-06 0:29 ` Ben Elliston
2007-12-06 9:53 ` Andreas Schwab
2007-12-06 0:42 ` Robert Dewar
[not found] <2007-12-02-11-05-39+trackit+sam@rfc1149.net.suse.lists.egcs>
2007-12-02 18:33 ` Andi Kleen
[not found] ` <jeodd9l7j1.fsf@sykes.suse.de.suse.lists.egcs>
[not found] ` <Pine.GSO.4.61.0712031739500.10932@mulga.csse.unimelb.edu.au.suse.lists.egcs>
2007-12-03 12:20 ` Andi Kleen
2007-12-04 4:03 ` Nicholas Nethercote
2007-12-04 13:05 ` Richard Kenner
2007-12-04 10:19 ` Robert Kiesling
[not found] ` <200712022136.57819.ebotcazou@libertysurf.fr.suse.lists.egcs>
[not found] ` <4aca3dc20712021240k19f3eae5j66453276179c401a@mail.gmail.com.suse.lists.egcs>
[not found] ` <200712022355.23871.ebotcazou@libertysurf.fr.suse.lists.egcs>
[not found] ` <4aca3dc20712021621n39a036d2u21f471f231dfffe@mail.gmail.com.suse.lists.egcs>
[not found] ` <10712031329.AA20246@vlsi1.ultra.nyu.edu.suse.lists.egcs>
2007-12-03 16:34 ` Andi Kleen
2007-12-03 16:38 ` Richard Kenner
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=Pine.GSO.4.61.0712031739500.10932@mulga.csse.unimelb.edu.au \
--to=njn@csse.unimelb.edu.au \
--cc=gcc@gcc.gnu.org \
--cc=sam@rfc1149.net \
--cc=schwab@suse.de \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).