User Guide - Mks.com

Using Keywords
graphical user interface can override the default settings. For information
on setting command keyword options, see “Command Preferences” on
page 48.
For information on setting the keyword options for individual commands,
see Source Integrity Enterprise Edition CLI Reference Guide or man pages.
Keyword expansion applies to text files only. It is disabled for binary files.
Text before and after the keyword is preserved, making it suitable for use
within expressions, as above, and within comments.
If keyword expansion is enabled and you are checking out a text file that
contains the string
$Revision$
Source Integrity, when it encounters this string, automatically adds the
value of the keyword $Revision$ in the format
where
$Revision: value $
value is the appropriate value of the keyword (in this case, the revision
number).
For example, including the statement
char revnum[] = "$Revision$";
in a C source file creates a character string named revnum containing the
file’s revision number. The program can then be configured to display this
string when it starts up, automatically presenting the current revision of
the program’s source file.
Using the $Revision$ keyword to obtain the revision number of a file is
one of the common applications of keywords. Other common applications
include:
The $Header$ keyword provides a one-line summary of useful
information associated with a revision. Including this information in a
comment makes the information available to anyone looking at the
member.
The $Log$ keyword supplies the same sort of information as
$Header$ plus the revision description. The $Log$ keyword provides
a complete list of changes that are made to the member over time.
209