From: Thien-Thi Nguyen <ttn@gnuvola.org>
To: monnier@iro.umontreal.ca
Cc: emacs-devel@gnu.org
Subject: Re: File names in ChangeLog entries
Date: Wed, 01 Dec 2021 14:22:51 -0500 [thread overview]
Message-ID: <87czmgruyc.fsf@gnuvola.org> (raw)
In-Reply-To: <jwvlf14yxsg.fsf-monnier+emacs@gnu.org> (Stefan Monnier's message of "Wed, 01 Dec 2021 13:46:52 -0500")
[-- Attachment #1: Type: text/plain, Size: 2466 bytes --]
[recip list trimmed]
() Stefan Monnier <monnier@iro.umontreal.ca>
() Wed, 01 Dec 2021 13:46:52 -0500
The Linux kernel uses the same principle where the first line
starts with a description of the "subsystem" that's affected.
Personally, in the ChangeLog entries i generate (for other
projects, not for Emacs), i generalize this principle. I.e.,
whereas Linux uses:
SUBSYSTEM: SHORT-DESCRIPTION
i use instead:
[SUBSYSTEM OTHER-ATTR] SHORT-DESCRIPTION
That OTHER-ATTR is often something like ‘C’ (for C code or
libraries, as opposed to Scheme, for exapmle), or ‘int’ (for
"internal" as opposed to user-visible). Example:
https://git.savannah.gnu.org/cgit/rcs.git/tree/ChangeLog
In any case, the practice makes it easy to filter and sort
changes (for those who like to ponder Change :-D).
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.
I suppose under the Linux practice, this could be:
pixel-scroll: Avoid unnecesary call when scrolling
and under mine:
[pixel-scroll int] Avoid unnecesary call when scrolling
Note that, because SUBSYSTEM establishes the context, there is
no need to include the "pixel" qualifier in SHORT-DESCRIPTION.
I am guessing about ‘int’ because the change seems to be
performance (efficiency) related and not user-visible.
BTW, in the past i always punctuated (placed a period at the end
of SHORT-DESCRIPTION), but i've come around to the mindset of
punctuationlessness of late.
I suggest we choose one of these methods and add it explicitly
to CONTRIBUTE. I see the "; SUMMARY" syntax is documented, why
not this, as well?
--
Thien-Thi Nguyen -----------------------------------------------
(defun responsep (query) ; (2021) Software Libero
(pcase (context query) ; = Dissenso Etico
(`(technical ,ml) (correctp ml))
...)) 748E A0E8 1CB8 A748 9BFA
--------------------------------------- 6CE4 6703 2224 4C80 7502
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 219 bytes --]
next prev parent reply other threads:[~2021-12-01 19:22 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 [this message]
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=87czmgruyc.fsf@gnuvola.org \
--to=ttn@gnuvola.org \
--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 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.