Next: Using keywords, Up: Keyword substitution [Contents][Index]
This is a list of the keywords:
$Author$
The login name of the user who checked in the revision.
$Date$
The date and time (UTC) the revision was checked in.
$Header$
A standard header containing the full pathname of the RCS file, the revision number, the date (UTC), the author, the state, and the locker (if locked). Files will normally never be locked when you use CVS.
$Id$
Same as $Header$
, except that the RCS
filename is without a path.
$Name$
Tag name used to check out this file. The keyword is
expanded only if one checks out with an explicit tag
name. For example, when running the command cvs
co -r first
, the keyword expands to ‘Name: first’.
$Locker$
The login name of the user who locked the revision
(empty if not locked, which is the normal case unless
cvs admin -l
is in use).
$Log$
The log message supplied during commit, preceded by a
header containing the RCS filename, the revision
number, the author, and the date (UTC). Existing log
messages are not replaced. Instead, the new log
message is inserted after $Log:…$
.
Each new line is prefixed with the same string which
precedes the $Log
keyword. For example, if the
file contains:
/* Here is what people have been up to: * * $Log: frob.c,v $ * Revision 1.1 1997/01/03 14:23:51 joe * Add the superfrobnicate option * */
then additional lines which are added when expanding
the $Log
keyword will be preceded by ‘ * ’.
Unlike previous versions of CVS and RCS, the
comment leader from the RCS file is not used.
The $Log
keyword is useful for
accumulating a complete change log in a source file,
but for several reasons it can be problematic.
See Log keyword.
$RCSfile$
The name of the RCS file without a path.
$Revision$
The revision number assigned to the revision.
$Source$
The full pathname of the RCS file.
$State$
The state assigned to the revision. States can be
assigned with cvs admin -s
—see admin options.
Next: Using keywords, Up: Keyword substitution [Contents][Index]