[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: ChangeLog?
From: |
Robert J. Chassell |
Subject: |
Re: ChangeLog? |
Date: |
Fri, 4 Mar 2005 00:41:39 +0000 (UTC) |
I gather the documentation contradicts this position.
No, it doesn't. That was a misunderstanding.
In Emacs, the approach we use is that all changes are listed in
ChangeLog.
Which ChangeLog? The Emacs CVS offers two ChangeLogs and in
(emacs)Types of Log File
the Emacs manual says
When you use version control, you can use just the per-file log if
you wish, or you can use both kinds of logs. ...
So I originally used the smaller, per-file ChangeLog. Miles persuaded
me to add a comment to the larger ChangeLog, which I did.
Shall I change the documentation as I suggested to:
emacs/man/files.texi
Types of Log File
When you use a version control system that provides a per-file
log, you should use @strong{both} the the per-file log and the
more general @file{ChangeLog}. This is because it is inconvenient
or impossible for someone using a different version control system
to access another version control system's per-file log. This
policy is different from the past, when you recorded small changes
in the per-file log only.
Typically you want to write just one entry for each change. You
can write the entry in @file{ChangeLog}, using the @kbd{C-x 4 a}
command (@pxref{Change Log}), and then copy it to the log buffer
when you check in the change. Or you can write the entry in the
log buffer while checking in the change, using the @kbd{C-x v v}
command, and later use the @kbd{C-x v a} command to copy it to the
more general @file{ChangeLog} (@pxref{Change Logs and VC}).
My hunch is that the current documentation is different than you
thought and that the changed documentation says what you mean.
--
Robert J. Chassell
address@hidden GnuPG Key ID: 004B4AC8
http://www.rattlesnake.com http://www.teak.cc