diff options
Diffstat (limited to 'src/engine/SCons/Tool/CVS.xml')
| -rw-r--r-- | src/engine/SCons/Tool/CVS.xml | 59 |
1 files changed, 51 insertions, 8 deletions
diff --git a/src/engine/SCons/Tool/CVS.xml b/src/engine/SCons/Tool/CVS.xml index 8546e6a..b8e16ed 100644 --- a/src/engine/SCons/Tool/CVS.xml +++ b/src/engine/SCons/Tool/CVS.xml @@ -1,67 +1,100 @@ +<?xml version="1.0" encoding="UTF-8"?> <!-- -Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation +Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation 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="CVS"> <summary> +<para> Sets construction variables for the CVS source code management system. +</para> </summary> <sets> -CVS -CVSCOM -CVSFLAGS -CVSCOFLAGS +<item>CVS</item> +<item>CVSCOM</item> +<item>CVSFLAGS</item> +<item>CVSCOFLAGS</item> </sets> <uses> -CVSCOMSTR +<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> @@ -70,6 +103,7 @@ This is referenced in the default (repository, module) </arguments> <summary> +<para> A factory function that returns a Builder object to be used to fetch source files @@ -80,11 +114,15 @@ 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 @@ -96,10 +134,13 @@ so that you only have to replicate part of the repository directory hierarchy in your local build directory. +</para> +<para> Examples: +</para> -<example> +<example_commands> # Will fetch foo/bar/src.c # from /usr/local/CVSROOT/foo/bar/src.c. env.SourceCode('.', env.CVS('/usr/local/CVSROOT')) @@ -111,6 +152,8 @@ 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> +</example_commands> </summary> </scons_function> + +</sconsdoc>
\ No newline at end of file |