Source

SCons / src / engine / SCons / Tool / SCCS.xml

Full commit
<?xml version="1.0" encoding="UTF-8"?>
<!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->

<!DOCTYPE sconsdoc [
<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'>
%scons;
<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'>
%builders-mod;
<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'>
%functions-mod;
<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'>
%tools-mod;
<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'>
%variables-mod;
]>

<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">

<tool name="SCCS">
<summary>
<para>
Sets construction variables for interacting with the
Source Code Control System.
</para>
</summary>
<sets>
<item>SCCS</item>
<item>SCCSFLAGS</item>
<item>SCCSGETFLAGS</item>
<item>SCCSCOM</item>
</sets>
<uses>
<item>SCCSCOMSTR</item>
</uses>
</tool>

<cvar name="SCCS">
<summary>
<para>
The SCCS executable.
</para>
</summary>
</cvar>

<cvar name="SCCSCOM">
<summary>
<para>
The command line used to
fetch source files from SCCS.
</para>
</summary>
</cvar>

<cvar name="SCCSCOMSTR">
<summary>
<para>
The string displayed when fetching
a source file from a CVS repository.
If this is not set, then &cv-link-SCCSCOM;
(the command line) is displayed.
</para>
</summary>
</cvar>

<cvar name="SCCSFLAGS">
<summary>
<para>
General options that are passed to SCCS.
</para>
</summary>
</cvar>

<cvar name="SCCSGETFLAGS">
<summary>
<para>
Options that are passed specifically to the SCCS "get" subcommand.
This can be set, for example, to
<option>-e</option>
to check out editable files from SCCS.
</para>
</summary>
</cvar>

<scons_function name="SCCS">
<arguments signature="env">
()
</arguments>
<summary>
<para>
A factory function that
returns a Builder object
to be used to fetch source files
from SCCS.
The returned Builder
is intended to be passed to the
&f-link-SourceCode;
function.
</para>

<para>
Example:
</para>

<example_commands>
env.SourceCode('.', env.SCCS())
</example_commands>

<para>
Note that
&scons;
will fetch source files
from SCCS subdirectories automatically,
so configuring SCCS
as demonstrated in the above example
should only be necessary if
you are fetching from
<filename>s.SCCS</filename>
files in the same
directory as the source files,
or if you need to explicitly specify SCCS
for a specific subdirectory.
</para>
</summary>
</scons_function>

</sconsdoc>