diff options
Diffstat (limited to 'doc/generated/functions.gen')
| -rw-r--r-- | doc/generated/functions.gen | 251 |
1 files changed, 29 insertions, 222 deletions
diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen index e80c1c9..79a83c6 100644 --- a/doc/generated/functions.gen +++ b/doc/generated/functions.gen @@ -96,7 +96,7 @@ Examples: # which the method will be called; the Python # convention is to call it 'self'. def my_method(self, arg): - print "my_method() got", arg + print("my_method() got", arg) # Use the global AddMethod() function to add a method # to the Environment class. This @@ -532,37 +532,6 @@ env.AppendUnique(CCFLAGS = '-g', FOO = ['foo.yyy']) </example_commands> </listitem> </varlistentry> - <varlistentry id="f-BitKeeper"> - <term> - <literal>env.BitKeeper()</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A factory function that -returns a Builder object -to be used to fetch source files -using BitKeeper. -The returned Builder -is intended to be passed to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> -function. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This function is deprecated. For details, see the entry for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> -function. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Example: -</para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.SourceCode('.', env.BitKeeper()) -</example_commands> -</listitem> - </varlistentry> <varlistentry id="f-BuildDir"> <term> <literal>BuildDir(build_dir, src_dir, [duplicate])</literal> @@ -999,63 +968,6 @@ A now-deprecated synonym for </para> </listitem> </varlistentry> - <varlistentry id="f-CVS"> - <term> - <literal>env.CVS(repository, module)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A factory function that -returns a Builder object -to be used to fetch source files -from the specified -CVS -<varname>repository</varname>. -The returned Builder -is intended to be passed to the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SourceCode"><function>SourceCode</function></link> -function. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This function is deprecated. For details, see the entry for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> -function. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The optional specified -<varname>module</varname> -will be added to the beginning -of all repository path names; -this can be used, in essence, -to strip initial directory names -from the repository path names, -so that you only have to -replicate part of the repository -directory hierarchy in your -local build directory. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Examples: -</para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -# Will fetch foo/bar/src.c -# from /usr/local/CVSROOT/foo/bar/src.c. -env.SourceCode('.', env.CVS('/usr/local/CVSROOT')) - -# Will fetch bar/src.c -# from /usr/local/CVSROOT/foo/bar/src.c. -env.SourceCode('.', env.CVS('/usr/local/CVSROOT', 'foo')) - -# Will fetch src.c -# from /usr/local/CVSROOT/foo/bar/src.c. -env.SourceCode('.', env.CVS('/usr/local/CVSROOT', 'foo/bar')) -</example_commands> -</listitem> - </varlistentry> <varlistentry id="f-Decider"> <term> <literal>Decider(function)</literal> @@ -1114,7 +1026,7 @@ timestamp, such as can happen when restoring files from backup archives. <listitem> <para> Specifies that a target shall be considered out of date and rebuilt -if the dependency's content has changed sine the last time +if the dependency's content has changed since the last time the target was built, as determined be performing an MD5 checksum on the dependency's contents @@ -1131,7 +1043,7 @@ can be used as a synonym for <listitem> <para> Specifies that a target shall be considered out of date and rebuilt -if the dependency's content has changed sine the last time +if the dependency's content has changed since the last time the target was built, except that dependencies with a timestamp that matches the last time the target was rebuilt will be @@ -2102,7 +2014,7 @@ import atexit def print_build_failures(): from SCons.Script import GetBuildFailures for bf in GetBuildFailures(): - print "%s failed: %s" % (bf.node, bf.errstr) + print("%s failed: %s" % (bf.node, bf.errstr)) atexit.register(print_build_failures) </example_commands> @@ -3062,56 +2974,6 @@ dict = env.ParseFlags('-O2', '!echo -Dfoo -Dbar=1') </example_commands> </listitem> </varlistentry> - <varlistentry id="f-Perforce"> - <term> - <literal>env.Perforce()</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A factory function that -returns a Builder object -to be used to fetch source files -from the Perforce source code management system. -The returned Builder -is intended to be passed to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> -function. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This function is deprecated. For details, see the entry for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> -function. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Example: -</para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.SourceCode('.', env.Perforce()) -</example_commands> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Perforce uses a number of external -environment variables for its operation. -Consequently, this function adds the -following variables from the user's external environment -to the construction environment's -ENV dictionary: -P4CHARSET, -P4CLIENT, -P4LANGUAGE, -P4PASSWD, -P4PORT, -P4USER, -SystemRoot, -USER, -and -USERNAME. -</para> -</listitem> - </varlistentry> <varlistentry id="f-Platform"> <term> <literal>Platform(string)</literal> @@ -3346,7 +3208,7 @@ every 10 Nodes: <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> def my_progress_function(node, *args, **kw): - print 'Evaluating node %s!' % node + print('Evaluating node %s!' % node) Progress(my_progress_function, interval=10) </example_commands> @@ -3458,50 +3320,28 @@ Multiple targets can be passed in to a single call to </para> </listitem> </varlistentry> - <varlistentry id="f-RCS"> + <varlistentry id="f-PyPackageDir"> <term> - <literal>env.RCS()</literal> + <literal>PyPackageDir(modulename)</literal> + </term> + <term> + <literal>env.PyPackageDir(modulename)</literal> </term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -A factory function that -returns a Builder object -to be used to fetch source files -from RCS. -The returned Builder -is intended to be passed to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> -function: -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This function is deprecated. For details, see the entry for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> -function. +This returns a Directory Node similar to Dir. +The python module / package is looked up and if located +the directory is returned for the location. +<varname>modulename</varname> +Is a named python package / module to +lookup the directory for it's location. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> -Examples: -</para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.SourceCode('.', env.RCS()) -</example_commands> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Note that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -will fetch source files -from RCS subdirectories automatically, -so configuring RCS -as demonstrated in the above example -should only be necessary if -you are fetching from -RCS,v -files in the same -directory as the source files, -or if you need to explicitly specify RCS -for a specific subdirectory. +If +<varname>modulename</varname> +is a list, SCons returns a list of Dir nodes. +Construction variables are expanded in +<varname>modulename</varname>. </para> </listitem> </varlistentry> @@ -3681,47 +3521,6 @@ below, for a complete explanation of the arguments and behavior. </para> </listitem> </varlistentry> - <varlistentry id="f-SCCS"> - <term> - <literal>env.SCCS()</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A factory function that -returns a Builder object -to be used to fetch source files -from SCCS. -The returned Builder -is intended to be passed to the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SourceCode"><function>SourceCode</function></link> -function. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Example: -</para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.SourceCode('.', env.SCCS()) -</example_commands> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Note that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -will fetch source files -from SCCS subdirectories automatically, -so configuring SCCS -as demonstrated in the above example -should only be necessary if -you are fetching from -<filename>s.SCCS</filename> -files in the same -directory as the source files, -or if you need to explicitly specify SCCS -for a specific subdirectory. -</para> -</listitem> - </varlistentry> <varlistentry id="f-SConscript"> <term> <literal>SConscript(scripts, [exports, variant_dir, duplicate])</literal> @@ -4199,6 +3998,14 @@ which corresponds to --random; and </listitem> </varlistentry> <varlistentry> +<term><literal>silent</literal></term> +<listitem> +<para> +which corresponds to --silent. +</para> +</listitem> +</varlistentry> +<varlistentry> <term><literal>stack_size</literal></term> <listitem> <para> |