Re: CVS commits and logs

[Eli Zaretskii <eliz@gnu.org>]

> From: Bill Wohler <wohler@newt.com>
> Date: Sun, 05 Nov 2006 15:15:06 -0800
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> >   . CVS log entries should be simply the ChangeLog entries with the
> >     file name and the leading TABs stripped.
> 
> I agree if only one file is committed. However, if multiple files are
> committed, I'd say leave the file names and strip the leading TABs.

But the next rule says each commit should be only one file, so there's
no ``if''.

> >   . Each file should be committed separately, even if the changes are
> >     related, and the CVS log entry should be for the changes in that
> >     file only.  In particular, the modified files and the ChangeLog
> >     file with the appropriate log entry should be committed separately
> >     (thus the CVS log entries for ChangeLog files should never include
> >     log entries for the modified files).  Exception: it is okay to
> >     commit several changes to a single ChangeLog file in one "cvs ci"
> >     command if those changes are related to the same feature/bugfix.
> 
> This isn't clear. In the first sentence you say, "even if the changes
> are related" but the exception says--paraphrased--"except if the
> change are related". Which is it?

The exception is from the second sentence that talks about ChangeLog
files only.

> by enumerating all of the file names in a single log message, you
> can see easily which files are affected by a given change.

As I understand, this can be seen from the ChangeLog itself, you don't
need to go to CVS.

Also, if multiple file commits are allowed, nothing prevents people
from committing unrelated changes in one go.

> I check in the ChangeLog at the same time as I check in the file whose
> change it describes. It's easy and the ChangeLog check-in is less
> prone to be forgotten. It seems this is a common practice. Is there a
> good reason for your rule?

Those are not my rules, I just took a liberty of describing the rules
Richard requested me to follow a long time ago.