summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Environment.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Environment.xml')
-rw-r--r--src/engine/SCons/Environment.xml42
1 files changed, 29 insertions, 13 deletions
diff --git a/src/engine/SCons/Environment.xml b/src/engine/SCons/Environment.xml
index 0127bc2..9b392d5 100644
--- a/src/engine/SCons/Environment.xml
+++ b/src/engine/SCons/Environment.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
-Copyright (c) 2001 - 2017 The SCons Foundation
+Copyright (c) 2001 - 2019 The SCons Foundation
This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
@@ -60,7 +60,7 @@ or this:
<example_commands>
env = Environment()
-env['BUILDERS]['NewBuilder'] = foo
+env['BUILDERS']['NewBuilder'] = foo
</example_commands>
</summary>
</cvar>
@@ -549,7 +549,7 @@ string, in which case a list will be returned instead of a string.
</para>
<para>
-If
+If
<varname>delete_existing</varname>
is 0, then adding a path that already exists
will not move it to the end; it will stay where it is in the list.
@@ -588,7 +588,7 @@ then any value(s) that already exist in the
construction variable will
<emphasis>not</emphasis>
be added again to the list.
-However, if delete_existing is 1,
+However, if delete_existing is 1,
existing matching values are removed first, so
existing values in the arg list move to the end of the list.
</para>
@@ -883,12 +883,14 @@ env4 = env.Clone(tools = ['msvc', MyTool])
<para>
The
<varname>parse_flags</varname>
-keyword argument is also recognized:
+keyword argument is also recognized to allow merging command-line
+style arguments into the appropriate construction
+variables (see &f-link-env-MergeFlags;).
</para>
<example_commands>
# create an environment for compiling programs that use wxWidgets
-wx_env = env.Clone(parse_flags = '!wx-config --cflags --cxxflags')
+wx_env = env.Clone(parse_flags='!wx-config --cflags --cxxflags')
</example_commands>
</summary>
</scons_function>
@@ -1211,6 +1213,17 @@ size, or content signature.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+<term><parameter>repo_node</parameter></term>
+<listitem>
+<para>
+Use this node instead of the one specified by
+<varname>dependency</varname>
+ to determine if the dependency has changed.
+</para>
+</listitem>
+</varlistentry>
+
</variablelist>
</para>
@@ -1247,7 +1260,7 @@ Example:
</para>
<example_commands>
-def my_decider(dependency, target, prev_ni):
+def my_decider(dependency, target, prev_ni, repo_node=None):
return not os.path.exists(str(target))
env.Decider(my_decider)
@@ -1880,9 +1893,9 @@ as the dependency.
</para>
<para>
-Note that this will only remove the dependencies listed from
-the files built by default. It will still be built if that
-dependency is needed by another object being built.
+Note that this will only remove the dependencies listed from
+the files built by default. It will still be built if that
+dependency is needed by another object being built.
See the third and forth examples below.
</para>
@@ -1954,8 +1967,8 @@ not as separate arguments to
<para>
New values are prepended to the environment variable by default,
-unless prepend=0 is specified.
-Duplicate values are always eliminated,
+unless prepend=0 is specified.
+Duplicate values are always eliminated,
since this function calls
&f-link-AppendENVPath;
or
@@ -2294,6 +2307,9 @@ and added to the following construction variables:
-frameworkdir= FRAMEWORKPATH
-include CCFLAGS
-isysroot CCFLAGS, LINKFLAGS
+-isystem CCFLAGS
+-iquote CCFLAGS
+-idirafter CCFLAGS
-I CPPPATH
-l LIBS
-L LIBPATH
@@ -2489,7 +2505,7 @@ then any value(s) that already exist in the
construction variable will
<emphasis>not</emphasis>
be added again to the list.
-However, if delete_existing is 1,
+However, if delete_existing is 1,
existing matching values are removed first, so
existing values in the arg list move to the front of the list.
</para>