GNU bug report logs - #8057
documentation of Summary: etc in log-edit buffers

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 8057 in the body.
You can then email your comments to 8057 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Reiner Steib <reiner.steib <at> gmx.de>
To: bug-gnu-emacs <at> gnu.org
Subject: 23.2.93; (PCL-CVS and) log-edit
Date: Wed, 16 Feb 2011 17:21:08 +0100

Hi,

assume you have this new entry in the file/buffer ChangeLog:

| 2011-02-16  Reiner Steib  <foo <at> invalid>
|
| 	* some-longish-file-name.txt (module): New.

In the *cvs* buffer, you mark the files some-longish-file-name.txt and
ChangeLog, then hit `C' (cvs-mode-commit-setup).

In Emacs 23.2.93, I get this log-edit buffer:

| Summary:
|
| * some-longish-file-name.txt (module): New.

Problem (1):

The user has no information what will happen to the pseudo headers
(e.g. "Summary:") and the empty lines.  By trial reading
`log-edit-done', I found out that they will not clutter the file's
commit log.

  ;; Clean up empty headers.
  [...]
  ;; Get rid of leading empty lines.

Maybe we could add some lines (at the bottom) similar like CVS:

| Summary:
|
| * Berechtigungen_und_Web-Access.txt (module): New.
|
| VC: ----------------------------------------------------------------------
| VC: Enter log message above this line.  Empty header lines (e.g.  
"Summary:"), empty
| VC: lines and lines beginning with `CVS:' are removed automatically.
| VC:
| VC: Press C-c C-c when you are done editing.
| VC: ----------------------------------------------------------------------

The lines starting with "VC: " should use `font-lock-comment-face'.

Problem (2):

In Emacs 23.2, I had:

| (module): New.

For single-file commits (ChangeLog not counted as a file), the file name
was stripped before setting up the log-edit buffer.  Is it possible to
restore this?

Bye, Reiner

Message #8 received at 8057 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Reiner Steib <reiner.steib <at> gmx.de>
Cc: 8057 <at> debbugs.gnu.org
Subject: Re: bug#8057: 23.2.93; (PCL-CVS and) log-edit
Date: Wed, 16 Feb 2011 19:25:11 -0500

Reiner Steib wrote:

> Problem (2):
>
> In Emacs 23.2, I had:
>
> | (module): New.
>
> For single-file commits (ChangeLog not counted as a file), the file name
> was stripped before setting up the log-edit buffer. 

The addition of the "Summary:" gunk (which there seems to be no way to
turn off?) and possibly other headers at the start of the log buffer has
broken the `log-edit-strip-single-file-name' functionality.

The following bit of log-edit-insert-changelog always fails now:

 (goto-char (point-min))
    (when (and log-edit-strip-single-file-name (looking-at "\\*\\s-+"))

because it finds itself looking at "Summary:".

Message #11 received at 8057 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Reiner Steib <reiner.steib <at> gmx.de>
Cc: 8057 <at> debbugs.gnu.org
Subject: Re: bug#8057: 23.2.93; (PCL-CVS and) log-edit
Date: Thu, 17 Feb 2011 02:27:19 -0500

> Reiner Steib wrote:
>
>> Problem (2):

Installed a fix for this.

Message #16 received at 8057 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: Reiner Steib <reiner.steib <at> gmx.de>
Cc: 8057 <at> debbugs.gnu.org
Subject: Re: 23.2.93; (PCL-CVS and) log-edit
Date: Thu, 14 Jul 2011 20:41:01 +0200

Reiner Steib <reiner.steib <at> gmx.de> writes:

> The user has no information what will happen to the pseudo headers
> (e.g. "Summary:") and the empty lines.  By trial reading
> `log-edit-done', I found out that they will not clutter the file's
> commit log.

[...]

> Maybe we could add some lines (at the bottom) similar like CVS:
>
> | Summary:
> |
> | * Berechtigungen_und_Web-Access.txt (module): New.
> |
> | VC: ----------------------------------------------------------------------
> | VC: Enter log message above this line.  Empty header lines (e.g.
> "Summary:"), empty
> | VC: lines and lines beginning with `CVS:' are removed automatically.
> | VC:
> | VC: Press C-c C-c when you are done editing.
> | VC: ----------------------------------------------------------------------

The empty summary lines could be a nuisance, I guess (although I've
never been presented with them myself).  When do they appear?

However, having all that text at the bottom of the buffer would be even
more annoying, I think.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Message #19 received at 8057 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: Reiner Steib <reiner.steib <at> gmx.de>
Cc: 8057 <at> debbugs.gnu.org
Subject: Re: 23.2.93; (PCL-CVS and) log-edit
Date: Sun, 11 Sep 2011 05:54:22 +0200

Reiner Steib <reiner.steib <at> gmx.de> writes:

> In Emacs 23.2.93, I get this log-edit buffer:
>
> | Summary:
> |
> | * some-longish-file-name.txt (module): New.
>
> Problem (1):
>
> The user has no information what will happen to the pseudo headers
> (e.g. "Summary:") and the empty lines.  By trial reading
> `log-edit-done', I found out that they will not clutter the file's
> commit log.

Why does it insert the Summary: header line, anyway?  Isn't the first
line you enter into the buffer the summary in any case?

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Message #22 received at 8057 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
Cc: 8057 <at> debbugs.gnu.org, Reiner Steib <reiner.steib <at> gmx.de>
Subject: Re: bug#8057: 23.2.93; (PCL-CVS and) log-edit
Date: Sun, 11 Sep 2011 01:02:07 -0400

> Why does it insert the Summary: header line, anyway?

Because the log-edit buffer now uses an RFC822-style format.  We should
probably push this further and make the separating line between the header
and the body more clear (e.g. font-lock it into a thin horizontal bar).

> Isn't the first line you enter into the buffer the summary in
> any case?

It depends on the VC backend.


        Stefan

Message #25 received at 8057 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Reiner Steib <reiner.steib <at> gmx.de>
Cc: 8057 <at> debbugs.gnu.org
Subject: Re: bug#8057: 23.2.93; (PCL-CVS and) log-edit
Date: Fri, 11 Oct 2019 22:31:32 +0200

Reiner Steib <reiner.steib <at> gmx.de> writes:

> assume you have this new entry in the file/buffer ChangeLog:
>
> | 2011-02-16  Reiner Steib  <foo <at> invalid>
> |
> | 	* some-longish-file-name.txt (module): New.
>
> In the *cvs* buffer, you mark the files some-longish-file-name.txt and
> ChangeLog, then hit `C' (cvs-mode-commit-setup).
>
> In Emacs 23.2.93, I get this log-edit buffer:
>
> | Summary:
> |
> | * some-longish-file-name.txt (module): New.
>
> Problem (1):
>
> The user has no information what will happen to the pseudo headers
> (e.g. "Summary:") and the empty lines.

This was eight years ago, and I think that in practice the introduction
of these header lines didn't lead to much confusion, so I think adding a
help text (as suggested by this bug report) is unnecessary, and I'm
closing this bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.