diff options
Diffstat (limited to 'src/engine/SCons/Tool/SCCS.xml')
| -rw-r--r-- | src/engine/SCons/Tool/SCCS.xml | 38 |
1 files changed, 37 insertions, 1 deletions
diff --git a/src/engine/SCons/Tool/SCCS.xml b/src/engine/SCons/Tool/SCCS.xml index 3d16eee..e8aa066 100644 --- a/src/engine/SCons/Tool/SCCS.xml +++ b/src/engine/SCons/Tool/SCCS.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. @@ -56,3 +56,39 @@ This can be set, for example, to to check out editable files from SCCS. </summary> </cvar> + +<scons_function name="SCCS"> +<arguments signature="env"> +() +</arguments> +<summary> +A factory function that +returns a Builder object +to be used to fetch source files +from SCCS. +The returned Builder +is intended to be passed to the +&f-link-SourceCode; +function. + +Example: + +<example> +env.SourceCode('.', env.SCCS()) +</example> + +Note that +&scons; +will fetch source files +from SCCS subdirectories automatically, +so configuring SCCS +as demonstrated in the above example +should only be necessary if +you are fetching from +<filename>s.SCCS</filename> +files in the same +directory as the source files, +or if you need to explicitly specify SCCS +for a specific subdirectory. +</summary> +</scons_function> |