diff options
Diffstat (limited to 'src/engine/SCons/Tool/Subversion.xml')
-rw-r--r-- | src/engine/SCons/Tool/Subversion.xml | 53 |
1 files changed, 52 insertions, 1 deletions
diff --git a/src/engine/SCons/Tool/Subversion.xml b/src/engine/SCons/Tool/Subversion.xml index d0d0e74..5e36259 100644 --- a/src/engine/SCons/Tool/Subversion.xml +++ b/src/engine/SCons/Tool/Subversion.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. @@ -45,3 +45,54 @@ General options that are passed to Subversion. </summary> </cvar> --> + +<!-- +<scons_function name="Subversion"> +<arguments signature="global"> +(repository, module) +</arguments> +<summary> +A factory function that +returns a Builder object +to be used to fetch source files +from the specified Subversion +<varname>repository</varname>. +The returned Builder +is intended to be passed to the +&f-link-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. + +This function is deprecated, see the entry for the +&f-SourceCode; +function. + +Example: + +<example> +# Will fetch foo/bar/src.c +# from /usr/local/Subversion/foo/bar/src.c. +env.SourceCode('.', env.Subversion('file:///usr/local/Subversion')) + +# Will fetch bar/src.c +# from /usr/local/Subversion/foo/bar/src.c. +env.SourceCode('.', env.Subversion('file:///usr/local/Subversion', 'foo')) + +# Will fetch src.c +# from /usr/local/Subversion/foo/bar/src.c. +env.SourceCode('.', env.Subversion('file:///usr/local/Subversion', 'foo/bar')) +</example> +</summary> +</scons_function> +--> |