Re: "svn commit" should always prompt after popping up a log message editor

mark benedetto king wrote:
> On Mon, Sep 29, 2003 at 09:09:55AM -0400, mark benedetto king wrote:
>
>>On Sat, Sep 27, 2003 at 02:29:58PM +0100, Philip Martin wrote:
>>
>>>Is the user expected to know that this is an option for aborting a
>>>commit? Should this be documented, and if so how? Should we add a
>>>description of the behaviour to the default log message?
...
> What do you think about changing EDITOR_EOF_PREFIX, as described below?
>
>>Changing EDITOR_EOF_PREFIX ("--This line...") seems reasonable, but I
>>remember the text being the subject of extensive debate in the past.
>>
>>My suggestion, in light of this change:
>>
>>--This line, and those below, will be ignored. An otherwise empty --
>>--log message will require confirmation before the commit proceeds. --

I don't want to start a long bikeshed debate, but take what you will from these thoughts...

Yes, definitely this should be changed to be more helpful. I think the marker line should remain as one line, but additional descriptive text could be inserted below it. Then we could feel comfortable about expanding or changing the descriptive text whenever and however we want to.

The marker line appears butted up after the last line of the composed log message, which can look ugly. Some people will leave a blank line in between, for aesthetics, being unaware of or uninterested in exactly how Subversion processes the text. Therefore Subversion ought to remove such trailing blank lines. (At the moment, Subversion keeps those blank lines, and also adds another one in its "svn log" output.)

While we're changing it, "those below" could imply that only the exact lines that already appear below it will be ignored. At least one person has admitted being afraid to touch the text below the line. I suggest something like:

[[[
-- This marker line, and anything below it, will be ignored. --
An otherwise empty log message will require confirmation before the commit
proceeds. The items scheduled in this commit are:

]]]

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu Oct 9 15:46:24 2003