From: Karl Fogel <kfogel@red-bean.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: emacs-devel@gnu.org, stefan@marxist.se, monnier@iro.umontreal.ca,
ttn@gnuvola.org, Juri Linkov <juri@linkov.net>
Subject: Re: File names in ChangeLog entries
Date: Thu, 02 Dec 2021 16:11:36 -0600 [thread overview]
Message-ID: <874k7qodwn.fsf@red-bean.com> (raw)
In-Reply-To: <83k0gnpbdm.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 02 Dec 2021 12:08:37 +0200")
On 02 Dec 2021, Eli Zaretskii wrote:
>> From: Juri Linkov <juri@linkov.net>
>> Cc: Stefan Kangas <stefan@marxist.se>, Eli Zaretskii
>> <eliz@gnu.org>,
>> emacs-devel@gnu.org, Stefan Monnier
>> <monnier@iro.umontreal.ca>,
>> Thien-Thi Nguyen <ttn@gnuvola.org>
>> Date: Thu, 02 Dec 2021 11:12:05 +0200
>>
>> > * [master~1208] Save position in mark ring before jumping to
>> > definition
>>
>> This is a good example of an unhelpful commit message.
>> There is no way to guess it's about lisp/help-mode.el.
>
>You don't need to guess, you need to look at the rest of the log
>message. We cannot realistically require that everything about
>the
>change will be clear from the summary. Mentioning file names is,
>IME,
>mostly a waste there, because the file name provides very little
>information about the change itself, and takes quite a lot of
>space,
>so doesn't allow to say enough about the change.
Agreed.
The point of the summary line is to encapsulate some recognizable
core thing about the change. When you're reading over, say, a
long vertical list of such summaries, you can quickly recognize
ones you already had some awareness of (and this makes branch
comparison much easier).
We'll never be able to fit *everything* in a summary line, and
there's no need to. If one needs further information about that
particular change, one can go look at the full message.
Best regards,
-Karl
next prev parent reply other threads:[~2021-12-02 22:11 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
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 [this message]
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=874k7qodwn.fsf@red-bean.com \
--to=kfogel@red-bean.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=juri@linkov.net \
--cc=monnier@iro.umontreal.ca \
--cc=stefan@marxist.se \
--cc=ttn@gnuvola.org \
/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.