all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: David Kastrup <dak@gnu.org>
To: Stefan Monnier <monnier@IRO.UMontreal.CA>
Cc: Glenn Morris <rgm@gnu.org>, emacs-devel@gnu.org
Subject: Re: master 5022e27: ; Do not overwrite preexisting contents of unread-command-events
Date: Sat, 08 Aug 2015 17:04:31 +0200	[thread overview]
Message-ID: <87bnehizy8.fsf@fencepost.gnu.org> (raw)
In-Reply-To: <jwvfv3t3lxl.fsf-monnier+emacs@gnu.org> (Stefan Monnier's message of "Sat, 08 Aug 2015 10:17:15 -0400")

Stefan Monnier <monnier@IRO.UMontreal.CA> writes:

>>>> Surely this change deserved to create a ChangeLog entry, rather than
>>>> being marked with "; " to exclude that.
>>> A ChangeLog entry would run over several dozens of lines and take the
>>> better part of an hour to create since C-x v a does not work with Git.
>>> I figured that nobody would even notice anyway.
>
> I think what Glenn said, was that the entry should not have started
> with ";".  That would have generated a sub-optimal ChangeLog entry,
> but that's better than no ChangeLog entry.

Let me make very clear that I looked at CONTRIBUTE first and finally
went by

- Start with a single unindented summary line explaining the change;
  do not end this line with a period.  If that line starts with a
  semi-colon and a space "; ", the log message will be ignored when
  generating the ChangeLog file.  Use this for minor commits that do
  not need separate ChangeLog entries, such as changes in etc/NEWS.

since the only listed alternative was a full GNU-style ChangeLog commit
message.  Without looking at CONTRIBUTE, I would have written up a
commit message like I do on other projects, _not_ listing every filename
and function name (which are listed in the accompanying context diff
"git log -p" produces).  That would have been little work and would have
made every bit of information readily accessible that one would want.

I was not sure that the ChengeLog-entry free variant was really the best
choice.  That's one of the reason I posted the patch for comment on the
Emacs-devel list.

I'll prepare a ChangeLog entry like Eli described and commit it.
I really cannot imagine that it will be useful ever to anybody as the
collection of function names and affected files is a rather random
assortment (I could not name a single one in spite of creating the
patch).  So I skipped out on work I could not imagine anyone to want.
I was wrong on that but in my defense I did solicit for feedback.

-- 
David Kastrup



  reply	other threads:[~2015-08-08 15:04 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20150804124300.13374.78396@vcs.savannah.gnu.org>
     [not found] ` <E1ZMbYa-0003UO-69@vcs.savannah.gnu.org>
2015-08-04 15:30   ` master 5022e27: ; Do not overwrite preexisting contents of unread-command-events Glenn Morris
2015-08-04 15:52     ` David Kastrup
2015-08-08  8:33       ` David Kastrup
2015-08-08  9:11         ` Eli Zaretskii
2015-08-08  9:38           ` David Kastrup
2015-08-08 10:18             ` Eli Zaretskii
2015-08-08 14:17         ` Stefan Monnier
2015-08-08 15:04           ` David Kastrup [this message]
2015-08-08 16:08             ` David Kastrup

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=87bnehizy8.fsf@fencepost.gnu.org \
    --to=dak@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@IRO.UMontreal.CA \
    --cc=rgm@gnu.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.