summaryrefslogtreecommitdiff
path: root/doc/generated/functions.gen
diff options
context:
space:
mode:
Diffstat (limited to 'doc/generated/functions.gen')
-rw-r--r--doc/generated/functions.gen23
1 files changed, 19 insertions, 4 deletions
diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen
index 79a83c6..9fc9d4b 100644
--- a/doc/generated/functions.gen
+++ b/doc/generated/functions.gen
@@ -1197,6 +1197,10 @@ Multiple calls to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function>
are legal,
and add to the list of default targets.
+As noted above, both forms of this call affect the
+same global list of default targets; the
+construction environment method applies
+construction variable expansion to the targets.
</para>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
@@ -3523,16 +3527,16 @@ below, for a complete explanation of the arguments and behavior.
</varlistentry>
<varlistentry id="f-SConscript">
<term>
- <literal>SConscript(scripts, [exports, variant_dir, duplicate])</literal>
+ <literal>SConscript(scripts, [exports, variant_dir, duplicate, must_exist])</literal>
</term>
<term>
- <literal>env.SConscript(scripts, [exports, variant_dir, duplicate])</literal>
+ <literal>env.SConscript(scripts, [exports, variant_dir, duplicate, must_exist])</literal>
</term>
<term>
- <literal>SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate])</literal>
+ <literal>SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist])</literal>
</term>
<term>
- <literal>env.SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate])</literal>
+ <literal>env.SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist])</literal>
</term>
<listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
@@ -3734,6 +3738,17 @@ TODO??? SConscript('build/SConscript', src_dir='src')
</para>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
+The optional
+<varname>must_exist</varname>
+argument, if true, causes an exception to be raised if a requested
+<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> file is not found. The current default is false,
+causing only a warning to be omitted, but this behavior is deprecated.
+For scripts which truly intend to be optional, transition to
+explicty supplying
+<literal>must_exist=False</literal> to the call.
+</para>
+
+<para xmlns="http://www.scons.org/dbxsd/v1.0">
Here are some composite examples:
</para>