summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Defaults.xml
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2019-12-28 17:14:59 +0100
committerJörg Frings-Fürst <debian@jff-webhosting.net>2019-12-28 17:14:59 +0100
commitf01695e065adbca6531dbf3a28e8a707c49eba23 (patch)
tree3574b43f98f25e7bbf9dfdcb3e90d54f23e8ae0c /src/engine/SCons/Defaults.xml
parent10b9d3fe4386c06efbb4d971e4e307b89e254faa (diff)
parent5fc601f5484c9463e3399c0e690db80b9c22386e (diff)
Merge branch 'feature/upstream' into develop
Diffstat (limited to 'src/engine/SCons/Defaults.xml')
-rw-r--r--src/engine/SCons/Defaults.xml18
1 files changed, 12 insertions, 6 deletions
diff --git a/src/engine/SCons/Defaults.xml b/src/engine/SCons/Defaults.xml
index e568c92..8f87c6e 100644
--- a/src/engine/SCons/Defaults.xml
+++ b/src/engine/SCons/Defaults.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0"?>
<!--
Copyright (c) 2001 - 2019 The SCons Foundation
@@ -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>