ChangeLog entries (was: [patch] ISA-support in GNU Mach PCMCIA core)

[Thomas Schwinge]

Hello!

On Tue, Sep 19, 2006 at 12:58:25AM +0200, Michael Banck wrote:
> On Mon, Sep 18, 2006 at 09:37:05PM +0200, Thomas Schwinge wrote:
> >     * i386/linux/configure: Regenerate.
> >     * i386/linux/device-drivers.h.in: Likewise.
> > 
> >     * i386/linux/configure.ac (AC_PCMCIA_OPTION): New function.
> 
> I thought one mentiones the configure: Regenerate after what prompted
> the regeneration in the first place.

Here is my version:

ChangeLog entries that have an empty line between them are independent of
each other.  (I admit that one could argue whether regenerating a
compiled file is independent of changing its source file or not, but in
my book it is.)  Now, you change such a source file --- configure.ac ---
and commit that change.

#v+
[Date.]  [Who.]  [Where.]

        * configure.ac: Foo.
#v-

Afterwards you regenerate the compiled file --- configure --- and commit
that change.  Then the ChangeLog looks like this:

#v+
[Date.]  [Who.]  [Where.]

        * configure: Regenerate.

        * configure.ac: Foo.
#v-

Of course, committing the whole lot directly as...

#v+
[Date.]  [Who.]  [Where.]

        * configure.ac: Foo.
        * configure: Regenerate.
#v-

... wouldn't be wrong either, but as I said, I don't know if the files's
time stamps will be alright then.


> Don't know whether the GCS have anything to say on this, though.

<http://www.gnu.org/prep/standards/html_node/Change-Logs.html>.

``6.8.1 Change Log Concepts

You can think of the change log as a conceptual ???undo list??? which
explains how earlier versions were different from the current version.

[...]

6.8.2 Style of Change Logs

[...]

Separate unrelated change log entries with blank lines. When two entries
represent parts of the same change, so that they work together, then
don't put blank lines between them.''


Regards,
 Thomas

signature.asc
Description: Digital signature