unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
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 13:46:52 -0500	[thread overview]
Message-ID: <jwvlf14yxsg.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <835ys8s1gg.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 01 Dec 2021 19:02:23 +0200")

>>     * filename (func): Short description
>> 
>>     Explanation
>> 
>>     * filename (func): Short description.
>> 
>> ?
>
> No.  I don't understand why you insist on putting the file/function
> part on the first (a.k.a. "header") line.  The header line is supposed
> to be a summary, so that the likes of

The first line summary should also summarize the files.

The Linux kernel uses the same principle where the first line starts
with a description of the "subsystem" that's affected.

That goes back to my original message in this thread: I regularly see
commit messages where the first line is only complete if you know to
which (set of) file(s) the change is applied.

E.g.:

    Avoid unnecessary call when pixel scrolling

Maybe this is a change in the `pixel-scroll` package, but it could also
be a change in some completely different package which happens to fix
a problem that occurs when used in conjunction with pixel scrolling.


        Stefan




  parent reply	other threads:[~2021-12-01 18:46 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
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 [this message]
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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=jwvlf14yxsg.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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

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).