[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: Tue, 1 Mar 2005 13:29:31 +0000 (UTC)

You make a good point that not everyone uses CVS, so ChangeLogs
produced by CVS are not so good.

    _All_ code changes (maybe not comment and doc changes) should have
    entries in the [big] ChangeLog file.

This means we need to change the Emacs Manual.  Currently,

        (emacs)Types of Log File

    When you use version control, you can use just the per-file log if
    you wish, or you can use both kinds of logs.  ...

This could be restated as

        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}).

    Robert J. Chassell                         
    address@hidden                         GnuPG Key ID: 004B4AC8
    http://www.rattlesnake.com                  http://www.teak.cc

reply via email to

[Prev in Thread] Current Thread [Next in Thread]