[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to emacs/man/files.texi
From: |
Robert J. Chassell |
Subject: |
[Emacs-diffs] Changes to emacs/man/files.texi |
Date: |
Tue, 25 Dec 2001 10:32:10 -0500 |
Index: emacs/man/files.texi
diff -c emacs/man/files.texi:1.60 emacs/man/files.texi:1.61
*** emacs/man/files.texi:1.60 Sat Nov 3 13:58:07 2001
--- emacs/man/files.texi Tue Dec 25 10:32:10 2001
***************
*** 1135,1140 ****
--- 1135,1141 ----
@menu
* Version Systems:: Supported version control back-end systems.
* VC Concepts:: Words and concepts related to version control.
+ * Types of Log File:: The per-file VC log in contrast to the ChangeLog.
@end menu
@node Version Systems
***************
*** 1218,1223 ****
--- 1219,1272 ----
at any time, but requires merging with changes from other users at
check-in time. However, CVS can also be set up to require locking.
(@pxref{CVS Options}).
+
+ @node Types of Log File
+ @subsubsection Types of Log File
+ @cindex Types of log file
+ @cindex Log File, types of
+
+ GNU projects under a revision control system generally possess
+ @emph{two} types of log. These help you keep track of what goes on.
+
+ One kind of log is the per-file log maintained by the revision control
+ system. This kind of log is called the @dfn{version control log}, or
+ sometimes the @dfn{revision control log}, address@hidden log', or
+ address@hidden log'. The other kind of log is a per-directory or
+ per-project log called the change log or @file{ChangeLog}.
+
+ @cindex Version control log
+ @cindex Revision control log
+ @cindex Per-file log
+ The per-file log is designed to tell you about each and every change
+ to a file. Each time you check in a change, you fill out a version
+ control log entry. (@xref{Log Buffer, Log Buffer, Features of the Log
+ Entry Buffer}.) Consequently, a per-file log is very detailed, with
+ remarks such as `fixed typo' as well as `re-wrote from scratch'.
+
+ @cindex Change log
+ @cindex Per-directory log
+ @cindex Per-project log
+ On the other hand, a per-directory or per-project log is intended to
+ provide a chronological record of when and why you and others changed
+ a program. A @file{ChangeLog} should be moderately, but not
+ excessively detailed.
+
+ A single @file{ChangeLog} file can record changes for all
+ the files in its directory and all its subdirectories. A small
+ program merits one @file{ChangeLog} file; a large program may well
+ merit several @file{ChangeLog} file, one in each major directory.
+ (@xref{Change Log, Change Log, Change Logs}.)
+
+ You can use the Emacs command @address@hidden 4 a}}
+ (@code{add-change-log-entry-other-window}) to add a new entry to a
+ change log file.
+
+ If you use RCS or CVS, you can generate change log entries
+ automatically from the version control log entries using
+ the @address@hidden v a}} (@code{vc-update-change-log}) command.
+ (@xref{Change Logs and VC, Change Logs and VC, Change Logs and VC}.)
+ When you do this, you will probably want to edit and shorten the
+ resulting @file{ChangeLog}.
@node VC Mode Line
@subsection Version Control and the Mode Line
- [Emacs-diffs] Changes to emacs/man/files.texi,
Robert J. Chassell <=