summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/CVS.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/CVS.xml')
-rw-r--r--src/engine/SCons/Tool/CVS.xml159
1 files changed, 159 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/CVS.xml b/src/engine/SCons/Tool/CVS.xml
new file mode 100644
index 000000000..1e695c54f
--- /dev/null
+++ b/src/engine/SCons/Tool/CVS.xml
@@ -0,0 +1,159 @@
+<?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="CVS">
+<summary>
+<para>
+Sets construction variables for the CVS source code
+management system.
+</para>
+</summary>
+<sets>
+<item>CVS</item>
+<item>CVSCOM</item>
+<item>CVSFLAGS</item>
+<item>CVSCOFLAGS</item>
+</sets>
+<uses>
+<item>CVSCOMSTR</item>
+</uses>
+</tool>
+
+<cvar name="CVS">
+<summary>
+<para>
+The CVS executable.
+</para>
+</summary>
+</cvar>
+
+<cvar name="CVSCOFLAGS">
+<summary>
+<para>
+Options that are passed to the CVS checkout subcommand.
+</para>
+</summary>
+</cvar>
+
+<cvar name="CVSCOM">
+<summary>
+<para>
+The command line used to
+fetch source files from a CVS repository.
+</para>
+</summary>
+</cvar>
+
+<cvar name="CVSCOMSTR">
+<summary>
+<para>
+The string displayed when fetching
+a source file from a CVS repository.
+If this is not set, then &cv-link-CVSCOM;
+(the command line) is displayed.
+</para>
+</summary>
+</cvar>
+
+<cvar name="CVSFLAGS">
+<summary>
+<para>
+General options that are passed to CVS.
+By default, this is set to
+<literal>-d $CVSREPOSITORY</literal>
+to specify from where the files must be fetched.
+</para>
+</summary>
+</cvar>
+
+<cvar name="CVSREPOSITORY">
+<summary>
+<para>
+The path to the CVS repository.
+This is referenced in the default
+&cv-link-CVSFLAGS; value.
+</para>
+</summary>
+</cvar>
+
+<scons_function name="CVS">
+<arguments signature="env">
+(repository, module)
+</arguments>
+<summary>
+<para>
+A factory function that
+returns a Builder object
+to be used to fetch source files
+from the specified
+CVS
+<varname>repository</varname>.
+The returned Builder
+is intended to be passed to the
+&f-link-SourceCode;
+function.
+</para>
+
+<para>
+This function is deprecated. For details, see the entry for the
+&f-SourceCode;
+function.
+</para>
+
+<para>
+The optional specified
+<varname>module</varname>
+will be added to the beginning
+of all repository path names;
+this can be used, in essence,
+to strip initial directory names
+from the repository path names,
+so that you only have to
+replicate part of the repository
+directory hierarchy in your
+local build directory.
+</para>
+
+<para>
+Examples:
+</para>
+
+<example_commands>
+# Will fetch foo/bar/src.c
+# from /usr/local/CVSROOT/foo/bar/src.c.
+env.SourceCode('.', env.CVS('/usr/local/CVSROOT'))
+
+# Will fetch bar/src.c
+# from /usr/local/CVSROOT/foo/bar/src.c.
+env.SourceCode('.', env.CVS('/usr/local/CVSROOT', 'foo'))
+
+# Will fetch src.c
+# from /usr/local/CVSROOT/foo/bar/src.c.
+env.SourceCode('.', env.CVS('/usr/local/CVSROOT', 'foo/bar'))
+</example_commands>
+</summary>
+</scons_function>
+
+</sconsdoc>