diff options
Diffstat (limited to 'doc/generated/functions.gen')
| -rw-r--r-- | doc/generated/functions.gen | 57 |
1 files changed, 44 insertions, 13 deletions
diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen index 79a83c6..5e8bebb 100644 --- a/doc/generated/functions.gen +++ b/doc/generated/functions.gen @@ -480,7 +480,7 @@ string, in which case a list will be returned instead of a string. </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -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. @@ -518,7 +518,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> @@ -820,12 +820,14 @@ env4 = env.Clone(tools = ['msvc', MyTool]) <para xmlns="http://www.scons.org/dbxsd/v1.0"> 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 <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-MergeFlags"><function>env.MergeFlags</function></link>). </para> <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> # 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> </listitem> </varlistentry> @@ -1137,6 +1139,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> @@ -1173,7 +1186,7 @@ Example: </para> <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -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) @@ -1197,6 +1210,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"> @@ -2527,9 +2544,9 @@ as the dependency. </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -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> @@ -2937,6 +2954,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 @@ -3147,7 +3167,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> @@ -3523,16 +3543,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 +3754,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> |