emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: File names in ChangeLog entries


From: Stefan Monnier
Subject: Re: File names in ChangeLog entries
Date: Wed, 01 Dec 2021 08:39:06 -0500
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux)

> entries.  You (Stefan) are one of the "worst offenders" in that
> department: your entries look very frequently backwards: first the
> file and function, then an empty line, then the detailed explanation
> of the change.  It should be the other way around (if you care about
> the quality of the logs).

Mmmhh... maybe there's a misunderstanding then.
I thought the agreed upon format is:

    * filenames: Short description

    Explanation.

    * file1 (func1): desc1.
    (func2): desc2.
    * file2 (func3): desc3.

Which can degenerate to:

    * filename (func): Short description

    Explanation or rest of the description.

when the change only touches a single function.
And I also use

    * file1: Short description

    Explanation.

    (func1): desc1.
    (func2): desc2.
    * file2 (func3): desc3.

when the change fundamentally only affects `file1` except for minor
adjustments in a few other files.

I'm not completely sure about the use of the `* ` at the beginning of
the first line, which is not very useful but I keep out of habit.


        Stefan




reply via email to

[Prev in Thread] Current Thread [Next in Thread]