diff options
| author | William Deegan <bill@baddogconsulting.com> | 2019-12-13 16:24:05 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-13 16:24:05 (GMT) |
| commit | 874884c748f2f480b0ef44444627662b2c203764 (patch) | |
| tree | cc67c412b09a3e4020295e2f30c1673ab1be2411 /src | |
| parent | 6929ca17fa0d14b26c215b48f3b84e7117132bb2 (diff) | |
| parent | ddab0035a4ec1b2de1d105e26f82dcc7d153dc4b (diff) | |
| download | SCons-874884c748f2f480b0ef44444627662b2c203764.zip SCons-874884c748f2f480b0ef44444627662b2c203764.tar.gz SCons-874884c748f2f480b0ef44444627662b2c203764.tar.bz2 | |
Merge pull request #3493 from mwichmann/defenv-2477
Tweak DefaultEnvironment descriptions
Diffstat (limited to 'src')
| -rw-r--r-- | src/engine/SCons/Defaults.xml | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/src/engine/SCons/Defaults.xml b/src/engine/SCons/Defaults.xml index f215f5a..22f46fe 100644 --- a/src/engine/SCons/Defaults.xml +++ b/src/engine/SCons/Defaults.xml @@ -572,15 +572,21 @@ searching the repositories. <scons_function name="DefaultEnvironment"> <arguments signature="global"> -([args]) +([**kwargs]) </arguments> <summary> <para> -Creates and returns a default construction environment object. -This construction environment is used internally by SCons -in order to execute many of the global functions in this list, -and to fetch source files transparently +Creates and returns the default &consenv; object. +The default &consenv; is used internally by SCons +in order to execute many of the global functions in this list +(i.e. those not called as methods of a specific +&consenv;), and to fetch source files transparently from source code management systems. +The default environment is a singleton, so the keyword +arguments affect it only on the first call, on subsequent +calls the already-constructed object is returned. +The default environment can be modified in the same way +as any &consenv;. </para> </summary> </scons_function> |