CVS commits and logs

[Eli Zaretskii]

It looks like some people are not aware of the guidelines about CVS
commits and commit logs, or maybe those guidelines are ambiguous or
unclear, because the style of the log text differs considerably from
one maintainer to another, and hints on commit procedure that is not
according to what I know.  See the few examples below.

I think Richard should decide what is the canonical form and what are
the guidelines that everybody should follow, and we should then
describe those guidelines in some file in admin/.  I describe here
the rules I know about, as a starting point:

  . CVS log entries should be simply the ChangeLog entries with the
    file name and the leading TABs stripped.  It is okay to reformat
    and refill the text to make a better use of the line real estate
    after the leading TABs were removed, but otherwise the text should
    remain intact (but see below for an exception).

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

  . Since the previous rule separates the text for similar or related
    changes in different files, entries that say "Ditto." or otherwise
    refer to text for other files' entries should be rewritten to be
    self-contained in the CVS log.  This is an exception from the
    first rule, which says that the ChangeLog text should generally
    remain intact.

  . The ChangeLog files should be committed with an empty log message
    (unless this is a real change in the ChangeLog file itself, not an
    addition of log entries).

Here are some random examples of the various styles we currently have
in CVS log (the entries are indented 2 spaces to the right):

lisp/ChangeLog:

  revision 1.10244
  date: 2006-11-03 13:54:32 +0000;  author: ramprasadb;  state: Exp;  lines: +4 
-0
  *** empty log message ***
  ----------------------------
  revision 1.10243
  date: 2006-11-02 23:46:14 +0000;  author: monnier;  state: Exp;  lines: +8 -0
  (server-auth-key): Remove.  Replace by a process-property.
  (server-start): Don't remove the file of the previous process, but
  instead clear out the place for the new file.
  (server-start): Set the :auth-key property.
  (server-process-filter): Use the :auth-key property.
  ----------------------------
  revision 1.10232
  date: 2006-10-30 21:34:15 +0000;  author: cyd;  state: Exp;  lines: +8 -0
          * tutorial.el: Move defvars to avoid bytecomp warnings.
          (tutorial--find-changed-keys): Check if viper-current-state is
          bound before using it.
          (help-with-tutorial): Check if viper-tutorial is defined before
          using it.
  ----------------------------
  revision 1.10200
  date: 2006-10-18 14:05:16 +0000;  author: jhd;  state: Exp;  lines: +6 -0
   * term/x-win.el (res-geometry): Don't set geometry from Xresources
   to default-frame-alist if default-frame-alist already contains
   widht/height.
  ----------------------------
  revision 1.10182
  date: 2006-10-11 06:47:35 +0000;  author: monnier;  state: Exp;  lines: +359 
-0
  Merge from upstream, upto version 5.22.
  After 5.0:
   `cperl-add-tags-recurse-noxs-fullpath': new function (for -batch mode)

   Fine-grained changelog:
  `cperl-hook-after-change':      New configuration variable
  `cperl-vc-sccs-header': Likewise.
  `cperl-vc-sccs-header': Likewise.
  `cperl-vc-header-alist':        Default via two preceding variables
  `cperl-invalid-face':   Remove double quoting under XEmacs


lisp/faces.el:

  revision 1.354
  date: 2006-09-14 23:54:44 +0000;  author: rms;  state: Exp;  lines: +1 -1
  (mode-line-faces): Group mode-line instead of modeline.
  ----------------------------
  revision 1.351
  date: 2006-06-28 23:29:26 +0000;  author: nickrob;  state: Exp;  lines: +1 -1
  * help-mode.el (help-xref-symbol-regexp): Add property as a keyword
  for ignoring links.

  * faces.el (read-face-name): Use it.
  ----------------------------
  revision 1.344
  date: 2005-11-20 15:24:27 +0000;  author: cyd;  state: Exp;  lines: +5 -11
          * faces.el: Revert 2005-11-17 change.  :ignore-defface is now
          handled automagically.
  ----------------------------
  revision 1.321
  date: 2005-06-22 01:22:40 +0000;  author: miles;  state: Exp;  lines: +1 -1
  Revision: address@hidden/emacs--cvs-trunk--0--patch-438

  Rename vertical-divider face to vertical-border

  2005-06-22  Miles Bader  <address@hidden>

     * lisp/faces.el (vertical-border): Renamed from `vertical-divider'.

  2005-06-22  Miles Bader  <address@hidden>

     * man/display.texi (Faces): Change `vertical-divider' to `vertical-border'.

  2005-06-22  Miles Bader  <address@hidden>

     * src/xfaces.c (Qvertical_border): Renamed from `Qvertical_divider'.
     (realize_basic_faces, syms_of_xfaces): Update references to it.
     * src/dispextern.h (enum face_id): Rename `VERTICAL_DIVIDER_FACE_ID'
     to `VERTICAL_BORDER_FACE_ID'.
     * src/dispnew.c (build_frame_matrix_from_leaf_window): Update references.
  ----------------------------