diff options
| author | Richard M. Stallman | 2005-03-06 17:18:12 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-03-06 17:18:12 +0000 |
| commit | bf96cde16b8e920a787fdc992faa575d4df0d192 (patch) | |
| tree | 54cab3b91f955ba47f8e20d17133ae33b8d15982 | |
| parent | 0c8a060e6a9e97e7c6330974376cef3980741df5 (diff) | |
| download | emacs-bf96cde16b8e920a787fdc992faa575d4df0d192.tar.gz emacs-bf96cde16b8e920a787fdc992faa575d4df0d192.zip | |
(Types of Log File): Explain how projects' methods can vary.
| -rw-r--r-- | man/files.texi | 38 |
1 files changed, 21 insertions, 17 deletions
diff --git a/man/files.texi b/man/files.texi index df7809309e8..fff30e21217 100644 --- a/man/files.texi +++ b/man/files.texi | |||
| @@ -1297,23 +1297,27 @@ check-in time. However, CVS can also be set up to require locking. | |||
| 1297 | @cindex log File, types of | 1297 | @cindex log File, types of |
| 1298 | @cindex version control log | 1298 | @cindex version control log |
| 1299 | 1299 | ||
| 1300 | GNU projects under a revision control system generally possess | 1300 | Projects that use a revision control system can have @emph{two} |
| 1301 | @emph{two} types of log for changes. One is the per-file log | 1301 | types of log for changes. One is the per-file log maintained by the |
| 1302 | maintained by the revision control system: each time you check in a | 1302 | revision control system: each time you check in a change, you must |
| 1303 | change, you must fill out a @dfn{log entry} for the change (@pxref{Log | 1303 | fill out a @dfn{log entry} for the change (@pxref{Log Buffer}). This |
| 1304 | Buffer}). This kind of log is called the @dfn{version control log}, | 1304 | kind of log is called the @dfn{version control log}, also the |
| 1305 | also the @dfn{revision control log}, @dfn{RCS log}, or @dfn{CVS log}. | 1305 | @dfn{revision control log}, @dfn{RCS log}, or @dfn{CVS log}. |
| 1306 | 1306 | ||
| 1307 | The other kind of log is the change log file, typically a file called | 1307 | The other kind of log is the file @file{ChangeLog} (@pxref{Change |
| 1308 | @file{ChangeLog}. It provides a chronological record of all changes | 1308 | Log}). It provides a chronological record of all changes to a large |
| 1309 | to a large portion of a program---one directory and its | 1309 | portion of a program---typically one directory and its subdirectories. |
| 1310 | subdirectories. A small program would use one @file{ChangeLog} file; | 1310 | A small program would use one @file{ChangeLog} file; a large program |
| 1311 | a large program may well merit a @file{ChangeLog} file in each major | 1311 | may well merit a @file{ChangeLog} file in each major directory. |
| 1312 | directory. @xref{Change Log}. | 1312 | @xref{Change Log}. |
| 1313 | 1313 | ||
| 1314 | When you use version control, you can use just the per-file log if you | 1314 | A project maintained with version control can use just the per-file |
| 1315 | wish, or you can use both kinds of logs. When you use both, you | 1315 | log, or it can use both kinds of logs. It can handle some files one |
| 1316 | typically want to write just one entry for each change. You can write | 1316 | way and some files the other way. Each project has its policy, which |
| 1317 | you should follow. | ||
| 1318 | |||
| 1319 | When the policy is to use both, you typically want to write an entry | ||
| 1320 | for each change just once, then put it into both logs. You can write | ||
| 1317 | the entry in @file{ChangeLog}, then copy it to the log buffer when you | 1321 | the entry in @file{ChangeLog}, then copy it to the log buffer when you |
| 1318 | check in the change. Or you can write the entry in the log buffer | 1322 | check in the change. Or you can write the entry in the log buffer |
| 1319 | while checking in the change, and later use the @kbd{C-x v a} command | 1323 | while checking in the change, and later use the @kbd{C-x v a} command |