unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: emacs-devel@gnu.org
Subject: Re: File names in ChangeLog entries
Date: Tue, 30 Nov 2021 15:55:17 -0800	[thread overview]
Message-ID: <CADwFkm=YwPV5-X7Mc9svDDw2n9iQ6y7hGmWxhCiXw9C1rSik5Q@mail.gmail.com> (raw)
In-Reply-To: <jwv4k7t2q4u.fsf-monnier+emacs@gnu.org>

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> FWIW, I can't remember the last time I looked at a ChangeLog file.

Indeed, I also never look at them.

> OTOH, I would really appreciate if people could be careful to always
> include some kind of file information on the first line of their commit.
> Too often I see commits whose first line doesn't unambiguously indicate
> which part of Emacs's code is changed.

In the past I often used the format

    Fix foo in image-dired.el

Recently, I've made some changes to image-dired.el where I instead used
the format

    image-dired: Fix foo

I quite like this format, as it is both easy to read and immediately
obvious what it's about.

Maybe it would make sense to start encouraging some more standardized
format for the first line of commit messages?  This seems like something
that was probably discussed in the past (before I was following
emacs-devel), so apologies in advance if I'm just beating a dead horse.



  reply	other threads:[~2021-11-30 23:55 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 [this message]
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
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='CADwFkm=YwPV5-X7Mc9svDDw2n9iQ6y7hGmWxhCiXw9C1rSik5Q@mail.gmail.com' \
    --to=stefan@marxist.se \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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).