Julian Foad <julianfoad@btopenworld.com> writes:
> 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.
Makes sense.
> 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.)
This I don't buy. Read on.
> 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:
>
> ]]]
I'd go ahead and take this a few steps further. Use this message to
explain that:
a) people are free to edit below the line -- as long as the line
remains, that block will be removed.
b) people are free to remove the line, and then anything that was
previously below it will be kept in the log message.
c) people are free to remove the line and everything below it.
Of course, word it better. If people know they can remove all that
stuff, then the complaint about abutting this text to their log
message is moot -- they can just do what I do and, open editor
opening, "select all" in the editor and delete the whole thing.
*Poof* Clean slate -- no more ugliness.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu Oct 9 16:11:56 2003