diff options
Diffstat (limited to 'doc/generated/functions.gen')
| -rw-r--r-- | doc/generated/functions.gen | 376 |
1 files changed, 80 insertions, 296 deletions
diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen index e55799c..60e733f 100644 --- a/doc/generated/functions.gen +++ b/doc/generated/functions.gen @@ -25,8 +25,8 @@ Creates an Action object for the specified <varname>action</varname>. -See the section "Action Objects," -below, for a complete explanation of the arguments and behavior. +See the manpage section "Action Objects" +for a complete explanation of the arguments and behavior. </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -221,6 +221,21 @@ AddOption('--prefix', help='installation prefix') env = Environment(PREFIX = GetOption('prefix')) </example_commands> + +<note xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> +While <function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> behaves like +<function>optparse.add_option</function>, +the behavior of options added by <function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> +which take arguments is underfined in +<command>scons</command> if whitespace +(rather than <literal>=</literal> sign) is used as +the separator on the command line when +the option is invoked. +Such usage should be avoided. +</para> +</note> + </listitem> </varlistentry> <varlistentry id="f-AddPostAction"> @@ -241,7 +256,8 @@ has been built. The specified action(s) may be an Action object, or anything that can be converted into an Action object -(see below). +See the manpage section "Action Objects" +for a complete explanation. </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -270,7 +286,8 @@ is built. The specified action(s) may be an Action object, or anything that can be converted into an Action object -(see below). +See the manpage section "Action Objects" +for a complete explanation. </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -444,7 +461,7 @@ Otherwise, the construction variable and the value of the keyword argument are both coerced to lists, and the lists are added together. -(See also the Prepend method, below.) +(See also the <function xmlns="http://www.scons.org/dbxsd/v1.0">Prepend</function> method). </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -568,8 +585,8 @@ or Creates a Builder object for the specified <varname>action</varname>. -See the section "Builder Objects," -below, for a complete explanation of the arguments and behavior. +See the manpage section "Builder Objects" +for a complete explanation of the arguments and behavior. </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -873,7 +890,7 @@ same-named existing construction variables. An action can be an external command, specified as a string, or a callable Python object; -see "Action Objects," below, +see the manpage section "Action Objects" for more complete information. Also note that a string specifying an external command may be preceded by an @@ -897,7 +914,7 @@ env.Command('foo.out', 'foo.in', env.Command('bar.out', 'bar.in', ["rm -f $TARGET", "$BAR_BUILD < $SOURCES > $TARGET"], - ENV = {'PATH' : '/usr/local/bin/'}) + ENV={'PATH': '/usr/local/bin/'}) def rename(env, target, source): import os @@ -905,7 +922,7 @@ def rename(env, target, source): env.Command('baz.out', 'baz.in', ["$BAZ_BUILD < $SOURCES > .tmp", - rename ]) + rename]) </example_commands> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -914,14 +931,14 @@ Note that the function will usually assume, by default, that the specified targets and/or sources are Files, if no other part of the configuration -identifies what type of entry it is. +identifies what type of entries they are. If necessary, you can explicitly specify that targets or source nodes should -be treated as directoriese +be treated as directories by using the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Dir"><function>Dir</function></link> or -<function>env.Dir</function>() +<function>env.Dir</function> functions. </para> @@ -937,9 +954,9 @@ env.Command(env.Dir('$DISTDIR')), None, make_distdir) </example_commands> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -(Also note that SCons will usually +Also note that SCons will usually automatically create any directory necessary to hold a target file, -so you normally don't need to create directories by hand.) +so you normally don't need to create directories by hand. </para> </listitem> </varlistentry> @@ -954,8 +971,8 @@ so you normally don't need to create directories by hand.) <para xmlns="http://www.scons.org/dbxsd/v1.0"> Creates a Configure object for integrated functionality similar to GNU autoconf. -See the section "Configure Contexts," -below, for a complete explanation of the arguments and behavior. +See the manpage section "Configure Contexts" +for a complete explanation of the arguments and behavior. </para> </listitem> </varlistentry> @@ -1385,7 +1402,8 @@ would supply a string as a directory name to a Builder method or function. Directory Nodes have attributes and methods that are useful in many situations; -see "File and Directory Nodes," below. +see manpage section "File and Directory Nodes" +for more information. </para> </listitem> </varlistentry> @@ -1528,8 +1546,8 @@ Executes an Action object. The specified <varname>action</varname> may be an Action object -(see the section "Action Objects," -below, for a complete explanation of the arguments and behavior), +(see manpage section "Action Objects" +for a complete explanation of the arguments and behavior), or it may be a command-line string, list of commands, or executable Python function, @@ -1686,7 +1704,8 @@ would supply a string as a file name to a Builder method or function. File Nodes have attributes and methods that are useful in many situations; -see "File and Directory Nodes," below. +see manpage section "File and Directory Nodes" +for more information. </para> </listitem> </varlistentry> @@ -2836,7 +2855,7 @@ and the construction variables they affect are as specified for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-ParseFlags"><function>env.ParseFlags</function></link> method (which this method calls). -See that method's description, below, +See that method's description for a table of options and construction variables. </para> </listitem> @@ -3539,8 +3558,8 @@ Return('val1 val2') Creates a Scanner object for the specified <varname>function</varname>. -See the section "Scanner Objects," -below, for a complete explanation of the arguments and behavior. +See manpage section "Scanner Objects" +for a complete explanation of the arguments and behavior. </para> </listitem> </varlistentry> @@ -4229,107 +4248,6 @@ env.SourceCode('no_source.c', None) </para> </listitem> </varlistentry> - <varlistentry id="f-SourceSignatures"> - <term> - <literal>SourceSignatures(type)</literal> - </term> - <term> - <literal>env.SourceSignatures(type)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Note: Although it is not yet officially deprecated, -use of this function is discouraged. -See the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Decider"><function>Decider</function></link> -function for a more flexible and straightforward way -to configure SCons' decision-making. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> -function tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -how to decide if a source file -(a file that is not built from any other files) -has changed since the last time it -was used to build a particular target file. -Legal values are -<literal>MD5</literal> -or -<literal>timestamp</literal>. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If the environment method is used, -the specified type of source signature -is only used when deciding whether targets -built with that environment are up-to-date or must be rebuilt. -If the global function is used, -the specified type of source signature becomes the default -used for all decisions -about whether targets are up-to-date. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<literal>MD5</literal> -means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -decides that a source file has changed -if the MD5 checksum of its contents has changed since -the last time it was used to rebuild a particular target file. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<literal>timestamp</literal> -means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -decides that a source file has changed -if its timestamp (modification time) has changed since -the last time it was used to rebuild a particular target file. -(Note that although this is similar to the behavior of Make, -by default it will also rebuild if the dependency is -<emphasis>older</emphasis> -than the last time it was used to rebuild the target file.) -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -There is no different between the two behaviors -for Python -<function xmlns="http://www.scons.org/dbxsd/v1.0">Value</function> -node objects. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<literal>MD5</literal> -signatures take longer to compute, -but are more accurate than -<literal>timestamp</literal> -signatures. -The default value is -<literal>MD5</literal>. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Note that the default -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-TargetSignatures"><function>TargetSignatures</function></link> -setting (see below) -is to use this -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> -setting for any target files that are used -to build other target files. -Consequently, changing the value of -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> -will, by default, -affect the up-to-date decision for all files in the build -(or all files built with a specific construction environment -when -<function xmlns="http://www.scons.org/dbxsd/v1.0">env.SourceSignatures</function> -is used). -</para> -</listitem> - </varlistentry> <varlistentry id="f-Split"> <term> <literal>Split(arg)</literal> @@ -4501,161 +4419,6 @@ Tag( 'file2.txt', DOC ) </example_commands> </listitem> </varlistentry> - <varlistentry id="f-TargetSignatures"> - <term> - <literal>TargetSignatures(type)</literal> - </term> - <term> - <literal>env.TargetSignatures(type)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Note: Although it is not yet officially deprecated, -use of this function is discouraged. -See the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Decider"><function>Decider</function></link> -function for a more flexible and straightforward way -to configure SCons' decision-making. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The -<function xmlns="http://www.scons.org/dbxsd/v1.0">TargetSignatures</function> -function tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -how to decide if a target file -(a file that -<emphasis>is</emphasis> -built from any other files) -has changed since the last time it -was used to build some other target file. -Legal values are -<literal>"build"</literal>; -<literal>"content"</literal> -(or its synonym -<literal>"MD5"</literal>); -<literal>"timestamp"</literal>; -or -<literal>"source"</literal>. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If the environment method is used, -the specified type of target signature is only used -for targets built with that environment. -If the global function is used, -the specified type of signature becomes the default -used for all target files that -don't have an explicit target signature type -specified for their environments. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<literal>"content"</literal> -(or its synonym -<literal>"MD5"</literal>) -means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -decides that a target file has changed -if the MD5 checksum of its contents has changed since -the last time it was used to rebuild some other target file. -This means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -will open up -MD5 sum the contents -of target files after they're built, -and may decide that it does not need to rebuild -"downstream" target files if a file was -rebuilt with exactly the same contents as the last time. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<literal>"timestamp"</literal> -means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -decides that a target file has changed -if its timestamp (modification time) has changed since -the last time it was used to rebuild some other target file. -(Note that although this is similar to the behavior of Make, -by default it will also rebuild if the dependency is -<emphasis>older</emphasis> -than the last time it was used to rebuild the target file.) -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<literal>"source"</literal> -means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -decides that a target file has changed -as specified by the corresponding -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> -setting -(<literal>"MD5"</literal> -or -<literal>"timestamp"</literal>). -This means that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -will treat all input files to a target the same way, -regardless of whether they are source files -or have been built from other files. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<literal>"build"</literal> -means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -decides that a target file has changed -if it has been rebuilt in this invocation -or if its content or timestamp have changed -as specified by the corresponding -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> -setting. -This "propagates" the status of a rebuilt file -so that other "downstream" target files -will always be rebuilt, -even if the contents or the timestamp -have not changed. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<literal>"build"</literal> -signatures are fastest because -<literal>"content"</literal> -(or -<literal>"MD5"</literal>) -signatures take longer to compute, -but are more accurate than -<literal>"timestamp"</literal> -signatures, -and can prevent unnecessary "downstream" rebuilds -when a target file is rebuilt to the exact same contents -as the previous build. -The -<literal>"source"</literal> -setting provides the most consistent behavior -when other target files may be rebuilt from -both source and target input files. -The default value is -<literal>"source"</literal>. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Because the default setting is -<literal>"source"</literal>, -using -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> -is generally preferable to -<function xmlns="http://www.scons.org/dbxsd/v1.0">TargetSignatures</function>, -so that the up-to-date decision -will be consistent for all files -(or all files built with a specific construction environment). -Use of -<function xmlns="http://www.scons.org/dbxsd/v1.0">TargetSignatures</function> -provides specific control for how built target files -affect their "downstream" dependencies. -</para> -</listitem> - </varlistentry> <varlistentry id="f-Tool"> <term> <literal>Tool(string, [toolpath, **kw])</literal> @@ -4949,30 +4712,51 @@ SConscript(dirs='doc', variant_dir='build/doc', duplicate=0) Searches for the specified executable <varname>program</varname>, returning the full path name to the program -if it is found, -and returning None if not. -Searches the specified -<varname>path</varname>, -the value of the calling environment's PATH -(<literal>env['ENV']['PATH']</literal>), -or the user's current external PATH -(<literal>os.environ['PATH']</literal>) -by default. +if it is found, else <literal>None</literal>. +Searches the value of the +<varname>path</varname> keyword argument, +or if <literal>None</literal> (the default) +the value of the calling environment's <envar>PATH</envar> +(<literal>env['ENV']['PATH']</literal>). +If <varname>path</varname> is <literal>None</literal> and +the <literal>env['ENV']['PATH']</literal> key does not exist, +the user's current external <envar>PATH</envar> +(<literal>os.environ['PATH']</literal>) is used as fallback. +</para> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> On Windows systems, searches for executable -programs with any of the file extensions -listed in the specified -<varname>pathext</varname>, -the calling environment's PATHEXT -(<literal>env['ENV']['PATHEXT']</literal>) -or the user's current PATHEXT +programs with any of the file extensions listed in the +<varname>pathext</varname> keyword argument, +or if <literal>None</literal> (the default) +the calling environment's <envar>PATHEXT</envar> +(<literal>env['ENV']['PATHEXT']</literal>). +The user's current external <envar>PATHEXT</envar> (<literal>os.environ['PATHEXT']</literal>) -by default. +is used as a fallback if <varname>pathext</varname> is +<literal>None</literal> +and the key <literal>env['ENV']['PATHEXT']</literal> +does not exist. +</para> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> Will not select any path name or names in the specified <varname>reject</varname> list, if any. </para> +<note xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> +If you would prefer to search +the user's current external <envar>PATH</envar> +(<literal>os.environ['PATH']</literal>) +by default, +consider using the function <literal>SCons.Util.WhereIs</literal> instead. +Note that <literal>SCons.Util.WhereIs</literal> +does not expand environment variables automatically +(no implicit <literal>env.subst</literal> for its arguments). +</para> +</note> + </listitem> </varlistentry> </variablelist> |