From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Juri Linkov <juri@linkov.net>,
kfogel@red-bean.com, stefan@marxist.se, emacs-devel@gnu.org,
ttn@gnuvola.org
Subject: Re: File names in ChangeLog entries
Date: Thu, 02 Dec 2021 16:09:20 -0500 [thread overview]
Message-ID: <jwvee6uyb7i.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <83k0gnpbdm.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 02 Dec 2021 12:08:37 +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.
I guess that begs the question: what do you think is the role of the
Summary, IOW how is it intended/expected to be used?
In my own experience, there are two main cases where I've made use of them:
- When listing a chain of commits for a particular change.
Usually the "particular change" already makes it clear which parts of
the code will likely be affected, so having subsystem information
there is not super important, admittedly.
Instead, I read the summaries as a kind of "roadmap" for how the
change is decomposed into a number of steps.
Since we're usually talking about a handful of commits, the specific
shape and content of those summaries doesn't matter very much (they
just need to include enough info that I know which commit is which).
- When listing a number of commits that were applied to a branch like
`master` or `emacs-28`, typically for code review, but other times to
look for changes relevant to some problem I'm experiencing or some
specific code I'm playing with.
In that case, having subsystem information in the summary makes
a world of difference in that I can much more easily skip changes
which are "obviously" irrelevant.
I wonder how you use them.
Stefan
next prev parent reply other threads:[~2021-12-02 21:09 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 [this message]
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=jwvee6uyb7i.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=juri@linkov.net \
--cc=kfogel@red-bean.com \
--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 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).