On Wed, 16 Oct 2013 13:16:39 +0200, Stephan Beal <[email protected]>
wrote:
On Tue, Oct 15, 2013 at 9:05 PM, j. van den hoff
<[email protected]>wrote:
the way the commit message should look like (sounds like a good
candidate
for the FAQ ...).
(to be pedantic for a moment (surprise! ;))... except that it fails the
"F"
part of "FAQ" ;).
But yeah, this should be mentioned somewhere. Suggestions are welcomed.
How
about simply to the basic commit help?
[stephan@host:~]$ f help commit
Usage: f commit ?OPTIONS? ?FILE...?
Create a new version containing all of the changes in the current
checkout. You will be prompted to enter a check-in comment unless
the comment has been specified on the command-line using "-m" or a
file containing the comment using -M. The editor defined in the
"editor" fossil option (see f help set) will be used, or from
the "VISUAL" or "EDITOR" environment variables (in that order) if
no editor is set.
<<<here somewhere>>>
yes, that would be sensible, I believe, although
actually, I've just "discovered" that it _is_ already stated in the commit
template itself:
"# Enter comments on this check-in. Lines beginning with # are ignored."
so this definitely _should_ have sufficed to notify the unwary user but it
did not (and then the help text probably is ignored, too...): in my case
the colleague in question seemingly took it for granted that the word
"comment" in the template text meant "shell-type comment (i.e. starting
with hash)) so he quite intentionally started his "comment" in this way.
so maybe that text better should be rephrased to something like:
"# Enter your commit message for this check-in above this line. Lines
beginning with # are ignored."
another question/idea: would it not be relatively easy to change the
behaviour to:
"# Enter your commit message for this check-in above this line. This line
and everything below is ignored."
meaning that this specific pattern (the whole, exact line) determines end
of the commit message (which then very well might include #-lines if the
user so desires)?
?
--
Using Opera's revolutionary email client: http://www.opera.com/mail/
_______________________________________________
fossil-users mailing list
[email protected]
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
