Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 25 Apr 2000 14:32:00 +0100
From:      Paul Richards <paul@originative.co.uk>
To:        Alexander Langer <alex@big.endian.de>
Cc:        Nik Clayton <nik@FreeBSD.ORG>, cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG
Subject:   Re: cvs commit: doc/en_US.ISO_8859-1/books/porter-handbook book.sgml
Message-ID:  <39059E50.78E0B20D@originative.co.uk>
References:  <200004222335.QAA55709@freefall.freebsd.org> <390586B7.C49BAAA2@originative.co.uk> <20000425141439.B7779@cichlids.cichlids.com>

next in thread | previous in thread | raw e-mail | index | archive | help
Alexander Langer wrote:
> 
> Thus spake Paul Richards (paul@originative.co.uk):
> 
> > be done in a separate email, not placed for all time into the commit
> > logs.
> 
> Hmm. I seriously wonder why: Usual translaters grab the cvslog/diffs
> of the English versions and merge these into the translations.
> 
> So it's obvious that the commitmessage is a good point to document,
> what one does one have to do to change.
> 
> What are the reasons against this?

The commit log is supposed to show the reason for the change, so that
when someone is later looking at the differences between the two
revisions they can gain an understanding of why the change was made.

It is not supposed to be a copy of what the change is, since that can be
found using cvs diff, and it is not supposed to be documentation
relating to what to do about the diff. The reason for the latter is that
a) it clogs up the diffs when you are trying to see *why* changes were
made b) if you later want to find that documentation the cvs logs are
likely to be one of the last places you will look.

I have long thought that it would be a good idea to add another tag to
the commit message that separates what the committer wants to put in the
logs, and what they would like to have sent to the list since I know
that it is all too tempting to just compile an email message there and
then, rather than fuss with sending a separate message to the list.

Shouldn't be too hard to do in our Perl scripts, just send all the text
before the tag into cvs, and include the rest in the mail message sent
out.

Paul.


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?39059E50.78E0B20D>