diff options
Diffstat (limited to 'src/engine/SCons/Tool/Perforce.xml')
| -rw-r--r-- | src/engine/SCons/Tool/Perforce.xml | 45 |
1 files changed, 44 insertions, 1 deletions
diff --git a/src/engine/SCons/Tool/Perforce.xml b/src/engine/SCons/Tool/Perforce.xml index 740977b..cc0f801 100644 --- a/src/engine/SCons/Tool/Perforce.xml +++ b/src/engine/SCons/Tool/Perforce.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,46 @@ If this is not set, then &cv-link-P4COM; (the command line) is displayed. General options that are passed to Perforce. </summary> </cvar> + +<scons_function name="Perforce"> +<arguments signature="env"> +() +</arguments> +<summary> +A factory function that +returns a Builder object +to be used to fetch source files +from the Perforce source code management system. +The returned Builder +is intended to be passed to the +&f-SourceCode; +function. + +This function is deprecated. For details, see the entry for the +&f-SourceCode; +function. + +Example: + +<example> +env.SourceCode('.', env.Perforce()) +</example> + +Perforce uses a number of external +environment variables for its operation. +Consequently, this function adds the +following variables from the user's external environment +to the construction environment's +ENV dictionary: +P4CHARSET, +P4CLIENT, +P4LANGUAGE, +P4PASSWD, +P4PORT, +P4USER, +SystemRoot, +USER, +and +USERNAME. +</summary> +</scons_function> |