Rcs Document Part6
Rcs Document Part6
Log The log message supplied during checkin, preceded by a header containing the
RCS filename, the revision number, the author, and the date and time. May
include an appended timezone offset.
Existing log messages are not replaced. Instead, the new log message is inserted
after ‘$Log:...$’. This is useful for accumulating a complete change log in a
source file.
Each inserted line is prefixed by the string that prefixes the ‘$Log$’ line. For
example, if the ‘$Log$’ line is
// $Log: tan.cc $
then RCS prefixes each line of the log with ‘// ’ (slash, slash, space). This is
useful for languages with comments that go to the end of the line.
The convention for other languages is to use a ‘ * ’ (space, asterisk, space)
prefix inside a multiline comment. For example, the initial log comment of a C
program conventionally is of the following form:
/*
* $Log$
*/
For backwards compatibility with older versions of RCS, if the log prefix is ‘/*’
or ‘(*’ surrounded by optional white space, inserted log lines contain a space
instead of ‘/’ or ‘(’; however, this usage is obsolescent and should not be relied
on.
Name The symbolic name used to check out the revision, if any. For example, ‘co
-rJoe’ generates ‘$Name: Joe $’. Plain co generates just ‘$Name: $’.
RCSfile The basename of the RCS file.
Revision The revision number assigned to the revision.
Source The absolute RCS filename.
State The state assigned to the revision with the -s option of rcs or ci.