8

I just upgraded to Emacs 24.4 (from 24.3). Now, whenever I run vc-next-action on a modified file, the *vc-log* buffer that comes up starts with the word "Summary:" in log-edit-header face, followed by a line of inverse video.

This wasn't happening in 24.3, but I can't find anything about it in NEWS. What's going on? I see this in both Git and Subversion working copies.

cjm
  • 193
  • 5

2 Answers2

5

Since around Emacs-24, the vc-log buffer supports/expects an RFC822-style format, with some headers handled specially (e.g. Author:, Fixes:, and Summary:). In Emacs-24.4, the default message content was changed to make this more clear.

Stefan
  • 26,154
  • 3
  • 46
  • 84
  • 1
    Can you expand on what the `Summary:` header does? – cjm Oct 27 '14 at 17:39
  • It should contain the summary of the change. It's the line that will appear for example in short log output (one line per change). – Stefan Oct 27 '14 at 19:48
  • 3
    To be clear, the 'Summary:' is included in the log message that's sent to the version control system. Personally, I am already using the convention that the first line of the log message is the summary, so I don't want to cruft up every commit with this extra word :-( – Ed Avis Nov 03 '14 at 16:52
  • No, "Summary:" is *not* included. – Stefan Nov 04 '14 at 12:58
  • 2
    @Stefan it is for me, though... (using RCS if that makes any difference) – petergil Nov 05 '14 at 06:38
  • Then it's a bug. Could you `M-x report-emacs-bug`? – Stefan Nov 05 '14 at 13:17
  • 2
    I see the Summary: header included in the log message, using svn, so as you suggest I have filed http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18954 – Ed Avis Nov 05 '14 at 14:47
  • 1
    The bug is now fixed in the emacs-25 branch, apparently. – Ed Avis Nov 25 '15 at 15:34
3

It's surprising that there is no way to configure this. You can choose whether the Author: header should appear, but Summary: is jammed in by default no matter what.

I had to redefine a function:

(load "log-edit")
(defun log-edit-insert-message-template ()
  "Insert the default template."
  (interactive)
  (when (or (called-interactively-p 'interactive)
            (log-edit-empty-buffer-p))
    (when log-edit-setup-add-author
      (insert "\nAuthor: "))
    (message-position-point)))

Compared with the vanilla version in log-edit.el, I deleted the lines adding "Summary:" and "\n\n".

Loading log-edit first is needed (if you put the above code in your .emacs) because otherwise the new definition would be overwritten when that library is loaded the first time you do a commit operation.

Ed Avis
  • 151
  • 4
  • 2
    In the bug reported above, http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18954, a workaround is given. log-edit-insert-message-template is simply removed from log-edit-hook. – Meaningful Username Dec 02 '14 at 10:57