summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Tool/RCS.xml
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2015-09-21 17:03:12 (GMT)
committerWilliam Deegan <bill@baddogconsulting.com>2015-09-21 17:03:12 (GMT)
commit0941093e0e5a030faa49968457638a3a6aee7ad8 (patch)
tree6d33513c14eb6eac0531dd050de0ecca4c39bd79 /src/engine/SCons/Tool/RCS.xml
downloadSCons-2.4.0.zip
SCons-2.4.0.tar.gz
SCons-2.4.0.tar.bz2
release 2.4.02.4.0
Diffstat (limited to 'src/engine/SCons/Tool/RCS.xml')
-rw-r--r--src/engine/SCons/Tool/RCS.xml142
1 files changed, 142 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/RCS.xml b/src/engine/SCons/Tool/RCS.xml
new file mode 100644
index 0000000..760f5c0
--- /dev/null
+++ b/src/engine/SCons/Tool/RCS.xml
@@ -0,0 +1,142 @@
+<?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 http://www.scons.org/dbxsd/v1.0/scons.xsd">
+
+<tool name="RCS">
+<summary>
+<para>
+Sets construction variables for the interaction
+with the Revision Control System.
+</para>
+</summary>
+<sets>
+<item>RCS</item>
+<item>RCS_CO</item>
+<item>RCS_COFLAGS</item>
+<item>RCS_COCOM</item>
+</sets>
+<uses>
+<item>RCS_COCOMSTR</item>
+</uses>
+</tool>
+
+<cvar name="RCS">
+<summary>
+<para>
+The RCS executable.
+Note that this variable is not actually used
+for the command to fetch source files from RCS;
+see the
+&cv-link-RCS_CO;
+construction variable, below.
+</para>
+</summary>
+</cvar>
+
+<cvar name="RCS_CO">
+<summary>
+<para>
+The RCS "checkout" executable,
+used to fetch source files from RCS.
+</para>
+</summary>
+</cvar>
+
+<cvar name="RCS_COCOM">
+<summary>
+<para>
+The command line used to
+fetch (checkout) source files from RCS.
+</para>
+</summary>
+</cvar>
+
+<cvar name="RCS_COCOMSTR">
+<summary>
+<para>
+The string displayed when fetching
+a source file from RCS.
+If this is not set, then &cv-link-RCS_COCOM;
+(the command line) is displayed.
+</para>
+</summary>
+</cvar>
+
+<cvar name="RCS_COFLAGS">
+<summary>
+<para>
+Options that are passed to the &cv-link-RCS_CO; command.
+</para>
+</summary>
+</cvar>
+
+<scons_function name="RCS">
+<arguments signature="env">
+()
+</arguments>
+<summary>
+<para>
+A factory function that
+returns a Builder object
+to be used to fetch source files
+from RCS.
+The returned Builder
+is intended to be passed to the
+&f-SourceCode;
+function:
+</para>
+
+<para>
+This function is deprecated. For details, see the entry for the
+&f-SourceCode;
+function.
+</para>
+
+<para>
+Examples:
+</para>
+
+<example_commands>
+env.SourceCode('.', env.RCS())
+</example_commands>
+
+<para>
+Note that
+&scons;
+will fetch source files
+from RCS subdirectories automatically,
+so configuring RCS
+as demonstrated in the above example
+should only be necessary if
+you are fetching from
+RCS,v
+files in the same
+directory as the source files,
+or if you need to explicitly specify RCS
+for a specific subdirectory.
+</para>
+</summary>
+</scons_function>
+
+</sconsdoc>