diff options
Diffstat (limited to 'src/engine/SCons/Tool/CVS.xml')
| -rw-r--r-- | src/engine/SCons/Tool/CVS.xml | 52 |
1 files changed, 51 insertions, 1 deletions
diff --git a/src/engine/SCons/Tool/CVS.xml b/src/engine/SCons/Tool/CVS.xml index d0a9357..4a0397e 100644 --- a/src/engine/SCons/Tool/CVS.xml +++ b/src/engine/SCons/Tool/CVS.xml @@ -1,5 +1,5 @@ <!-- -Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 The SCons Foundation +Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 The SCons Foundation This file is processed by the bin/SConsDoc.py module. See its __doc__ string for a discussion of the format. @@ -64,3 +64,53 @@ This is referenced in the default &cv-link-CVSFLAGS; value. </summary> </cvar> + +<scons_function name="CVS"> +<arguments signature="env"> +(repository, module) +</arguments> +<summary> +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. + +This function is deprecated. For details, see the entry for the +&f-SourceCode; +function. + +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. + +Examples: + +<example> +# 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> +</summary> +</scons_function> |