my final 2c:
before my colleague tripped over this by _assuming_ that "comment" in the
checkin template meant "shell (or perl, python, whatever) type comment"
and, due to this misconception _intentionally_ formatted his commit
message with leading `#' I was not aware of the potential problem (never
happpened to me, anyway). another poster mentioned to trip over the same
problem by referring to "#include" (or similar) in his commit message,
which I presume _might_ happen by and then to the unwary user, too.
still I agree that the sanest way is to keep it simple and identify
ignored lines by some leading short ring. here's what mercurial does:
8<----------------------------------------------------
HG: Enter commit message. Lines beginning with 'HG:' are removed.
HG: Leave message empty to abort commit.
HG: --
HG: user: someone
HG: branch 'default'
HG: added tt
8<----------------------------------------------------
I'd say that is more reaonsable than `#' (and to abort the checkin when
the message is left empty is, too, but that's another story...). so what
about -- for one -- mimicking `mercurial' here and to use
`FOSSIL:' or even `FOS:' as the unique identifier (which mostly is what
somebody else already proposed). I'd say that will work better than `#'
(i.e. accidentally names clash very very unlikely) and sufficiently stands
out on the respective lines due to the capitalization.
On Thu, 17 Oct 2013 15:31:37 +0200, Stephan Beal <[email protected]>
wrote:
On Thu, Oct 17, 2013 at 3:14 PM, Stestagg <[email protected]> wrote:
Using a marker line would allow for commit messages to contain any
content
i can't say that i would like commit messages to be able to contain "any
content." They're not intended to be general purposes documentation, but
_brief_ descriptions of changes made in the context of the current
commit.
A commit message field is not intended to hold a whole changelog for a
release nor a combined list of all changes from commits imported en masse
from another SCM (for such uses, just keep the change list as a separate
file and check it in along with the commit).
IMO the whole thing is far more trouble than it's worth and introduces
many
corner cases and bugs where we currently don't have any (or only have
very
old, well-understood ones which we can blame on the other systems which
were emulated ;). "If it ain't broke, don't touch it."
--
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
