From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Eli Zaretskii <eliz@gnu.org>
Cc: stefan@marxist.se, emacs-devel@gnu.org
Subject: Re: File names in ChangeLog entries
Date: Wed, 01 Dec 2021 08:39:06 -0500 [thread overview]
Message-ID: <jwvczmgih6u.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <831r2xt32t.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 01 Dec 2021 05:29:46 +0200")
> 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
next prev parent reply other threads:[~2021-12-01 13:39 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-30 19:19 File names in ChangeLog entries Stefan Kangas
2021-11-30 20:07 ` Philip Kaludercic
2021-11-30 22:01 ` Philipp Stephani
2021-11-30 23:24 ` Stefan Kangas
2021-12-01 3:24 ` Eli Zaretskii
2021-11-30 23:56 ` Andreas Schwab
2021-12-01 3:26 ` Eli Zaretskii
2021-11-30 23:16 ` Stefan Monnier
2021-11-30 23:55 ` Stefan Kangas
2021-12-01 3:32 ` Eli Zaretskii
2021-12-01 3:29 ` Eli Zaretskii
2021-12-01 13:39 ` Stefan Monnier [this message]
2021-12-01 13:52 ` Eli Zaretskii
2021-12-01 16:51 ` Stefan Monnier
2021-12-01 17:02 ` Eli Zaretskii
2021-12-01 17:28 ` Karl Fogel
2021-12-01 18:46 ` Stefan Monnier
2021-12-01 19:12 ` Eli Zaretskii
2021-12-01 19:22 ` Thien-Thi Nguyen
2021-12-01 19:32 ` Eli Zaretskii
2021-12-01 20:49 ` Thien-Thi Nguyen
2021-12-02 6:37 ` Eli Zaretskii
2021-12-01 21:03 ` Stefan Monnier
2021-12-01 21:50 ` Stefan Kangas
2021-12-01 22:21 ` Stefan Monnier
2021-12-01 23:14 ` Stefan Kangas
2021-12-02 6:43 ` Karl Fogel
2021-12-02 7:10 ` Stefan Monnier
2021-12-02 9:12 ` Juri Linkov
2021-12-02 10:08 ` Eli Zaretskii
2021-12-02 21:09 ` Stefan Monnier
2021-12-03 7:36 ` Eli Zaretskii
2021-12-03 12:57 ` Stefan Monnier
2021-12-03 13:06 ` Eli Zaretskii
2021-12-02 22:11 ` Karl Fogel
2021-12-02 11:02 ` Stefan Kangas
2021-12-03 2:43 ` Karl Fogel
2021-12-02 7:12 ` Eli Zaretskii
2021-12-02 7:34 ` Stefan Monnier
2021-12-02 8:33 ` Eli Zaretskii
2021-12-02 6:40 ` Eli Zaretskii
2021-12-02 16:59 ` Matt Armstrong
2021-12-01 6:11 ` Alfred M. Szmidt
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=jwvczmgih6u.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=stefan@marxist.se \
/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.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.