From: "Robert J. Chassell" <bob@rattlesnake.com>
Subject: Re: ChangeLog?
Date: Fri, 4 Mar 2005 13:42:55 +0000 (UTC) [thread overview]
Message-ID: <m1D7D4x-0004RCC@rattlesnake.com> (raw)
In-Reply-To: <fc339e4a05030317352e18458@mail.gmail.com> (message from Miles Bader on Fri, 4 Mar 2005 10:35:16 +0900)
Miles Bader wrote,
... I've read the info file now, and it seems pretty explicit and
clear about the distinction between the two types of logs.
Yes. I wrote that text years and years ago with wording intended to
create such a distinction. At that time, when people referred to a
`change log', it was often difficult to determine to which of several
types of change log they refered.
I am glad to see that the distinction has taken hold and that when an
expert says `change log' (which can be written in various ways), he or
she means only the more general change log and not the per-file change
log modified by CVS.
This suggests a change in the documentation in
emacs/man/files.texi
Types of Log File
that is different from what I previously suggested.
You might want to change this proposed wording to include references
to Arch and Subversion and perhaps to other version control systems.
I do not know anything about them and and written this with that
ignorance in mind.
This new wording replaces the last paragraph of the node, the
paragraph that begins with the sentence
When you use version control, you can use just the per-file log
if you wish, or you can use both kinds of logs.
Here is my current sample wording:
Some projects use several different version control systems at the
same time, synchronizing changes among them.
In Emacs development under CVS, the practice is to record
@emph{all} coding changes in the more general @file{ChangeLog} but
not changes in documentation or in the @file{NEWS} and
@file{FOR-RELEASE} files. Those latter changes are recorded only
in the per-file log, a log which may be inaccessible to someone
using a different version control system. (Other projects may
work differently.)
Thus, in Emacs development when both types of log are available
and when recording changes in code, you should use @strong{both}
the per-file log and the more general @file{ChangeLog}
In such a situation you typically will 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 per-file log, when that exists,
buffer when you check in the change. Or, when using the @kbd{C-x
v v} command (@pxref{Log Buffer}), you can write the entry in the
per-file log buffer while checking in the change, and later use
the @kbd{C-x v a} command to copy it to the more general
@file{ChangeLog} (@pxref{Change Logs and VC}).
--
Robert J. Chassell
bob@rattlesnake.com GnuPG Key ID: 004B4AC8
http://www.rattlesnake.com http://www.teak.cc
next prev parent reply other threads:[~2005-03-04 13:42 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <61k6osjqsz.fsf@fencepost.gnu.org>
[not found] ` <m1D5t7c-0004QmC@rattlesnake.com>
[not found] ` <fc339e4a05022814485fe422fb@mail.gmail.com>
2005-03-01 13:29 ` ChangeLog? Robert J. Chassell
2005-03-01 14:12 ` ChangeLog? Stefan Monnier
2005-03-01 15:06 ` ChangeLog? Kim F. Storm
2005-03-01 16:11 ` ChangeLog? Stefan Monnier
2005-03-03 2:27 ` ChangeLog? Richard Stallman
2005-03-03 3:20 ` ChangeLog? Miles Bader
2005-03-03 20:57 ` ChangeLog? Richard Stallman
2005-03-04 0:41 ` ChangeLog? Robert J. Chassell
2005-03-04 0:53 ` ChangeLog? Luc Teirlinck
2005-03-04 1:35 ` ChangeLog? Miles Bader
2005-03-04 13:42 ` Robert J. Chassell [this message]
2005-03-04 1:49 ` ChangeLog? Nick Roberts
2005-03-04 23:46 ` ChangeLog? Richard Stallman
2005-03-04 23:46 ` ChangeLog? Richard Stallman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=m1D7D4x-0004RCC@rattlesnake.com \
--to=bob@rattlesnake.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).