[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] Fix bug: Init auto var to unrandomize `stack_depth' rv.
From: |
Ludovic Courtès |
Subject: |
Re: [PATCH] Fix bug: Init auto var to unrandomize `stack_depth' rv. |
Date: |
Wed, 13 Jan 2010 11:02:47 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/23.1 (gnu/linux) |
Hi,
Thien-Thi Nguyen <address@hidden> writes:
> Often i include some kind of commentary describing the patch or
> the motivation of the patch, etc. Where should i include that
> info? Maybe "git-format-patch --attach"?
I would advise adding explanatory comments in the code, rather than in
the log.
>From the GCS (info "(standards) Change Log Concepts"):
There's no need to describe the full purpose of the changes or how
they work together. If you think that a change calls for explanation,
you're probably right. Please do explain it--but please put the
explanation in comments in the code, where people will see it whenever
they see the code. For example, "New function" is enough for the
change log when you add a function, because there should be a comment
before the function definition to explain what it does.
Thanks,
Ludo’.