1297 |
@cindex log File, types of |
@cindex log File, types of |
1298 |
@cindex version control log |
@cindex version control log |
1299 |
|
|
1300 |
GNU projects under a revision control system generally possess |
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 |
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 |
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 |
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}, |
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}. |
@dfn{revision control log}, @dfn{RCS log}, or @dfn{CVS log}. |
1306 |
|
|
1307 |
The other kind of log is the change log file, typically a file called |
The other kind of log is the file @file{ChangeLog} (@pxref{Change |
1308 |
@file{ChangeLog}. It provides a chronological record of all changes |
Log}). It provides a chronological record of all changes to a large |
1309 |
to a large portion of a program---one directory and its |
portion of a program---typically one directory and its subdirectories. |
1310 |
subdirectories. A small program would use one @file{ChangeLog} file; |
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 |
may well merit a @file{ChangeLog} file in each major directory. |
1312 |
directory. @xref{Change Log}. |
@xref{Change Log}. |
1313 |
|
|
1314 |
When you use version control, you can use just the per-file log if you |
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 |
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 |
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 |
1321 |
the entry in @file{ChangeLog}, then copy it to the log buffer when you |
the entry in @file{ChangeLog}, then copy it to the log buffer when you |
1322 |
check in the change. Or you can write the entry in the log buffer |
check in the change. Or you can write the entry in the log buffer |
1323 |
while checking in the change, and later use the @kbd{C-x v a} command |
while checking in the change, and later use the @kbd{C-x v a} command |