bug#8057: 23.2.93; (PCL-CVS and) log-edit

bug#8057: 23.2.93; (PCL-CVS and) log-edit

[Reiner Steib]

Hi,

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

| 2011-02-16  Reiner Steib  <foo@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

bug#8057: 23.2.93; (PCL-CVS and) log-edit

[Glenn Morris]

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:".

bug#8057: 23.2.93; (PCL-CVS and) log-edit

[Glenn Morris]

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

Installed a fix for this.

bug#8057: 23.2.93; (PCL-CVS and) log-edit

[Lars Magne Ingebrigtsen]

Reiner Steib <reiner.steib@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/

bug#8057: 23.2.93; (PCL-CVS and) log-edit

[Lars Magne Ingebrigtsen]

Reiner Steib <reiner.steib@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/

bug#8057: 23.2.93; (PCL-CVS and) log-edit

[Stefan Monnier]

> 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

bug#8057: 23.2.93; (PCL-CVS and) log-edit

[Lars Ingebrigtsen]

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

> assume you have this new entry in the file/buffer ChangeLog:
>
> | 2011-02-16  Reiner Steib  <foo@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