diff options
Diffstat (limited to 'doc/generated')
| -rw-r--r-- | doc/generated/builders.gen | 118 | ||||
| -rw-r--r-- | doc/generated/examples/caching_ex-random_1.xml | 6 | ||||
| -rw-r--r-- | doc/generated/examples/troubleshoot_Dump_1.xml | 30 | ||||
| -rw-r--r-- | doc/generated/examples/troubleshoot_Dump_2.xml | 40 | ||||
| -rw-r--r-- | doc/generated/examples/troubleshoot_explain1_3.xml | 2 | ||||
| -rw-r--r-- | doc/generated/examples/troubleshoot_stacktrace_2.xml | 2 | ||||
| -rw-r--r-- | doc/generated/functions.gen | 489 | ||||
| -rw-r--r-- | doc/generated/functions.mod | 12 | ||||
| -rw-r--r-- | doc/generated/tools.gen | 92 | ||||
| -rw-r--r-- | doc/generated/variables.gen | 568 | ||||
| -rw-r--r-- | doc/generated/variables.mod | 6 |
11 files changed, 481 insertions, 884 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 7c62558..59d2dca 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -48,11 +48,15 @@ env.CFile(target = 'bar', source = 'bar.y') </term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -The <function xmlns="http://www.scons.org/dbxsd/v1.0">Command</function> "Builder" is actually implemented -as a function that looks like a Builder, -but actually takes an additional argument of the action -from which the Builder should be made. -See the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Command"><function>Command</function></link> function description +The <function xmlns="http://www.scons.org/dbxsd/v1.0">Command</function> "Builder" is actually +a function that looks like a Builder, +but takes a required third argument, which is the +action to take to construct the target +from the source, used for "one-off" builds +where a full builder is not needed. +Thus it does not follow the builder +calling rules described at the start of this section. +See instead the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Command"><function>Command</function></link> function description for the calling syntax and details. </para> </listitem> @@ -465,6 +469,22 @@ a builder. <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> env.Install('/usr/local/bin', source = ['foo', 'bar']) </example_commands> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +If the <option>--install-sandbox</option> command line +option is given, the target directory will be prefixed +by the directory path specified. +This is useful to test installs without installing to +a "live" location in the system. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +See also <function xmlns="http://www.scons.org/dbxsd/v1.0">FindInstalledFiles</function>. +For more thoughts on installation, see the User Guide +(particularly the section on Command-Line Targets +and the chapters on Installing Files and on Alias Targets). +</para> + </listitem> </varlistentry> <varlistentry id="b-InstallAs"> @@ -1841,72 +1861,28 @@ env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) <function>env.ProgramAllAtOnce()</function> </term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - Builds an executable from D sources without first creating individual - objects for each file. - </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - D sources can be compiled file-by-file as C and C++ source are, and - D is integrated into the <filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> Object and Program builders for - this model of build. D codes can though do whole source - meta-programming (some of the testing frameworks do this). For this - it is imperative that all sources are compiled and linked in a single call of - the D compiler. This builder serves that purpose. - </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> - env.ProgramAllAtOnce('executable', ['mod_a.d, mod_b.d', 'mod_c.d']) - </example_commands> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - This command will compile the modules mod_a, mod_b, and mod_c in a - single compilation process without first creating object files for - the modules. Some of the D compilers will create executable.o others - will not. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - Builds an executable from D sources without first creating individual - objects for each file. - </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - D sources can be compiled file-by-file as C and C++ source are, and - D is integrated into the <filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> Object and Program builders for - this model of build. D codes can though do whole source - meta-programming (some of the testing frameworks do this). For this - it is imperative that all sources are compiled and linked in a single call of - the D compiler. This builder serves that purpose. - </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> - env.ProgramAllAtOnce('executable', ['mod_a.d, mod_b.d', 'mod_c.d']) - </example_commands> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - This command will compile the modules mod_a, mod_b, and mod_c in a - single compilation process without first creating object files for - the modules. Some of the D compilers will create executable.o others - will not. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - Builds an executable from D sources without first creating individual - objects for each file. - </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - D sources can be compiled file-by-file as C and C++ source are, and - D is integrated into the <filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> Object and Program builders for - this model of build. D codes can though do whole source - meta-programming (some of the testing frameworks do this). For this - it is imperative that all sources are compiled and linked in a single call of - the D compiler. This builder serves that purpose. - </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> - env.ProgramAllAtOnce('executable', ['mod_a.d, mod_b.d', 'mod_c.d']) - </example_commands> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - This command will compile the modules mod_a, mod_b, and mod_c in a - single compilation process without first creating object files for - the modules. Some of the D compilers will create executable.o others - will not. - </para> - </listitem> + <para xmlns="http://www.scons.org/dbxsd/v1.0"> + Builds an executable from D sources without first creating individual + objects for each file. + </para> + <para xmlns="http://www.scons.org/dbxsd/v1.0"> + D sources can be compiled file-by-file as C and C++ source are, and + D is integrated into the <filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> Object and Program builders for + this model of build. D codes can though do whole source + meta-programming (some of the testing frameworks do this). For this + it is imperative that all sources are compiled and linked in a single + call to the D compiler. This builder serves that purpose. + </para> + <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> + env.ProgramAllAtOnce('executable', ['mod_a.d, mod_b.d', 'mod_c.d']) + </example_commands> + <para xmlns="http://www.scons.org/dbxsd/v1.0"> + This command will compile the modules mod_a, mod_b, and mod_c in a + single compilation process without first creating object files for + the modules. Some of the D compilers will create executable.o others + will not. + </para> +</listitem> </varlistentry> <varlistentry id="b-RES"> <term> diff --git a/doc/generated/examples/caching_ex-random_1.xml b/doc/generated/examples/caching_ex-random_1.xml index d484ca4..1c99727 100644 --- a/doc/generated/examples/caching_ex-random_1.xml +++ b/doc/generated/examples/caching_ex-random_1.xml @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="UTF-8"?> <screen xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> -cc -o f4.o -c f4.c cc -o f3.o -c f3.c -cc -o f5.o -c f5.c -cc -o f2.o -c f2.c +cc -o f4.o -c f4.c cc -o f1.o -c f1.c +cc -o f2.o -c f2.c +cc -o f5.o -c f5.c cc -o prog f1.o f2.o f3.o f4.o f5.o </screen> diff --git a/doc/generated/examples/troubleshoot_Dump_1.xml b/doc/generated/examples/troubleshoot_Dump_1.xml index 99518c0..1f6f250 100644 --- a/doc/generated/examples/troubleshoot_Dump_1.xml +++ b/doc/generated/examples/troubleshoot_Dump_1.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <screen xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... -{ 'BUILDERS': {'_InternalInstall': <function InstallBuilderWrapper at 0x700000&gt;, '_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000&gt;, '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000&gt;}, +{ 'BUILDERS': {'_InternalInstall': <function InstallBuilderWrapper at 0x700000>, '_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>, '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>}, 'CONFIGUREDIR': '#/.sconf_temp', 'CONFIGURELOG': '#/config.log', 'CPPSUFFIXES': [ '.c', @@ -25,16 +25,16 @@ scons: Reading SConscript files ... '.SPP', '.sx'], 'DSUFFIXES': ['.d'], - 'Dir': <SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;, - 'Dirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;, + 'Dir': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, + 'Dirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, 'ENV': { 'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'}, - 'ESCAPE': <function escape at 0x700000&gt;, - 'File': <SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;, + 'ESCAPE': <function escape at 0x700000>, + 'File': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, 'HOST_ARCH': None, 'HOST_OS': None, 'IDLSUFFIXES': ['.idl', '.IDL'], - 'INSTALL': <function copyFunc at 0x700000&gt;, - 'INSTALLVERSIONEDLIB': <function copyFuncVersionedLib at 0x700000&gt;, + 'INSTALL': <function copyFunc at 0x700000>, + 'INSTALLVERSIONEDLIB': <function copyFuncVersionedLib at 0x700000>, 'LIBPREFIX': 'lib', 'LIBPREFIXES': ['$LIBPREFIX'], 'LIBSUFFIX': '.a', @@ -45,15 +45,15 @@ scons: Reading SConscript files ... 'PLATFORM': 'posix', 'PROGPREFIX': '', 'PROGSUFFIX': '', - 'PSPAWN': <function piped_env_spawn at 0x700000&gt;, - 'RDirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;, - 'SCANNERS': [<SCons.Scanner.Base object at 0x700000&gt;], + 'PSPAWN': <function piped_env_spawn at 0x700000>, + 'RDirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, + 'SCANNERS': [<SCons.Scanner.Base object at 0x700000>], 'SHELL': 'sh', 'SHLIBPREFIX': '$LIBPREFIX', 'SHLIBSUFFIX': '.so', 'SHOBJPREFIX': '$OBJPREFIX', 'SHOBJSUFFIX': '$OBJSUFFIX', - 'SPAWN': <function subprocess_spawn at 0x700000&gt;, + 'SPAWN': <function subprocess_spawn at 0x700000>, 'TARGET_ARCH': None, 'TARGET_OS': None, 'TEMPFILE': <class 'SCons.Platform.TempFileMunge'>, @@ -69,10 +69,10 @@ scons: Reading SConscript files ... '__LDMODULEVERSIONFLAGS': '${__libversionflags(__env__,"LDMODULEVERSION","_LDMODULEVERSIONFLAGS")}', '__RPATH': '$_RPATH', '__SHLIBVERSIONFLAGS': '${__libversionflags(__env__,"SHLIBVERSION","_SHLIBVERSIONFLAGS")}', - '__libversionflags': <function __libversionflags at 0x700000&gt;, - '_concat': <function _concat at 0x700000&gt;, - '_defines': <function _defines at 0x700000&gt;, - '_stripixes': <function _stripixes at 0x700000&gt;} + '__libversionflags': <function __libversionflags at 0x700000>, + '_concat': <function _concat at 0x700000>, + '_defines': <function _defines at 0x700000>, + '_stripixes': <function _stripixes at 0x700000>} scons: done reading SConscript files. scons: Building targets ... scons: `.' is up to date. diff --git a/doc/generated/examples/troubleshoot_Dump_2.xml b/doc/generated/examples/troubleshoot_Dump_2.xml index d83fb94..4b8aa0b 100644 --- a/doc/generated/examples/troubleshoot_Dump_2.xml +++ b/doc/generated/examples/troubleshoot_Dump_2.xml @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="UTF-8"?> <screen xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> scons: Reading SConscript files ... -{ 'BUILDERS': {'_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000&gt;, '_InternalInstall': <function InstallBuilderWrapper at 0x700000&gt;, 'Object': <SCons.Builder.CompositeBuilder object at 0x700000&gt;, 'PCH': <SCons.Builder.BuilderBase object at 0x700000&gt;, 'RES': <SCons.Builder.BuilderBase object at 0x700000&gt;, 'SharedObject': <SCons.Builder.CompositeBuilder object at 0x700000&gt;, 'StaticObject': <SCons.Builder.CompositeBuilder object at 0x700000&gt;, '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000&gt;}, +{ 'BUILDERS': {'_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>, '_InternalInstall': <function InstallBuilderWrapper at 0x700000>, 'Object': <SCons.Builder.CompositeBuilder object at 0x700000>, 'PCH': <SCons.Builder.BuilderBase object at 0x700000>, 'RES': <SCons.Builder.BuilderBase object at 0x700000>, 'SharedObject': <SCons.Builder.CompositeBuilder object at 0x700000>, 'StaticObject': <SCons.Builder.CompositeBuilder object at 0x700000>, '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>}, 'CC': 'cl', - 'CCCOM': <SCons.Action.FunctionAction object at 0x700000&gt;, + 'CCCOM': <SCons.Action.FunctionAction object at 0x700000>, 'CCFLAGS': ['/nologo'], 'CCPCHFLAGS': ['${(PCH and "/Yu%s \\"/Fp%s\\""%(PCHSTOP or "",File(PCH))) or ""}'], 'CCPDBFLAGS': ['${(PDB and "/Z7") or ""}'], @@ -38,20 +38,20 @@ scons: Reading SConscript files ... 'CXXFILESUFFIX': '.cc', 'CXXFLAGS': ['$(', '/TP', '$)'], 'DSUFFIXES': ['.d'], - 'Dir': <SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;, - 'Dirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;, + 'Dir': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, + 'Dirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, 'ENV': { 'PATH': 'C:\\WINDOWS\\System32', 'PATHEXT': '.COM;.EXE;.BAT;.CMD', 'SystemRoot': 'C:\\WINDOWS'}, - 'ESCAPE': <function escape at 0x700000&gt;, - 'File': <SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;, + 'ESCAPE': <function escape at 0x700000>, + 'File': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, 'HOST_ARCH': '', 'HOST_OS': 'win32', 'IDLSUFFIXES': ['.idl', '.IDL'], 'INCPREFIX': '/I', 'INCSUFFIX': '', - 'INSTALL': <function copyFunc at 0x700000&gt;, - 'INSTALLVERSIONEDLIB': <function copyFuncVersionedLib at 0x700000&gt;, + 'INSTALL': <function copyFunc at 0x700000>, + 'INSTALLVERSIONEDLIB': <function copyFuncVersionedLib at 0x700000>, 'LEXUNISTD': ['--nounistd'], 'LIBPREFIX': '', 'LIBPREFIXES': ['$LIBPREFIX'], @@ -66,26 +66,26 @@ scons: Reading SConscript files ... 'PLATFORM': 'win32', 'PROGPREFIX': '', 'PROGSUFFIX': '.exe', - 'PSPAWN': <function piped_spawn at 0x700000&gt;, + 'PSPAWN': <function piped_spawn at 0x700000>, 'RC': 'rc', - 'RCCOM': <SCons.Action.FunctionAction object at 0x700000&gt;, + 'RCCOM': <SCons.Action.FunctionAction object at 0x700000>, 'RCFLAGS': ['/nologo'], 'RCSUFFIXES': ['.rc', '.rc2'], - 'RDirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;, - 'SCANNERS': [<SCons.Scanner.Base object at 0x700000&gt;], + 'RDirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, + 'SCANNERS': [<SCons.Scanner.Base object at 0x700000>], 'SHCC': '$CC', - 'SHCCCOM': <SCons.Action.FunctionAction object at 0x700000&gt;, + 'SHCCCOM': <SCons.Action.FunctionAction object at 0x700000>, 'SHCCFLAGS': ['$CCFLAGS'], 'SHCFLAGS': ['$CFLAGS'], 'SHCXX': '$CXX', 'SHCXXCOM': '${TEMPFILE("$SHCXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $SHCXXFLAGS $SHCCFLAGS $_CCCOMCOM","$SHCXXCOMSTR")}', 'SHCXXFLAGS': ['$CXXFLAGS'], - 'SHELL': 'command', + 'SHELL': None, 'SHLIBPREFIX': '', 'SHLIBSUFFIX': '.dll', 'SHOBJPREFIX': '$OBJPREFIX', 'SHOBJSUFFIX': '$OBJSUFFIX', - 'SPAWN': <function spawn at 0x700000&gt;, + 'SPAWN': <function spawn at 0x700000>, 'STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME': 1, 'TARGET_ARCH': None, 'TARGET_OS': None, @@ -98,14 +98,14 @@ scons: Reading SConscript files ... '_CPPINCFLAGS': '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', '_LIBDIRFLAGS': '$( ${_concat(LIBDIRPREFIX, LIBPATH, LIBDIRSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', '_LIBFLAGS': '${_concat(LIBLINKPREFIX, LIBS, LIBLINKSUFFIX, __env__)}', - '_MSVC_OUTPUT_FLAG': <function msvc_output_flag at 0x700000&gt;, + '_MSVC_OUTPUT_FLAG': <function msvc_output_flag at 0x700000>, '__DSHLIBVERSIONFLAGS': '${__libversionflags(__env__,"DSHLIBVERSION","_DSHLIBVERSIONFLAGS")}', '__LDMODULEVERSIONFLAGS': '${__libversionflags(__env__,"LDMODULEVERSION","_LDMODULEVERSIONFLAGS")}', '__SHLIBVERSIONFLAGS': '${__libversionflags(__env__,"SHLIBVERSION","_SHLIBVERSIONFLAGS")}', - '__libversionflags': <function __libversionflags at 0x700000&gt;, - '_concat': <function _concat at 0x700000&gt;, - '_defines': <function _defines at 0x700000&gt;, - '_stripixes': <function _stripixes at 0x700000&gt;} + '__libversionflags': <function __libversionflags at 0x700000>, + '_concat': <function _concat at 0x700000>, + '_defines': <function _defines at 0x700000>, + '_stripixes': <function _stripixes at 0x700000>} scons: done reading SConscript files. scons: Building targets ... scons: `.' is up to date. diff --git a/doc/generated/examples/troubleshoot_explain1_3.xml b/doc/generated/examples/troubleshoot_explain1_3.xml index ed8f6d9..ebc13f8 100644 --- a/doc/generated/examples/troubleshoot_explain1_3.xml +++ b/doc/generated/examples/troubleshoot_explain1_3.xml @@ -3,5 +3,5 @@ cp file.in file.oout scons: warning: Cannot find target file.out after building -File "/Users/bdbaddog/devel/scons/git/as_scons/src/script/scons.py", line 204, in <module> +File "/home/bdeegan/devel/scons/git/as_scons/src/script/scons.py", line 204, in <module> </screen> diff --git a/doc/generated/examples/troubleshoot_stacktrace_2.xml b/doc/generated/examples/troubleshoot_stacktrace_2.xml index 2d88ae8..70a429d 100644 --- a/doc/generated/examples/troubleshoot_stacktrace_2.xml +++ b/doc/generated/examples/troubleshoot_stacktrace_2.xml @@ -4,7 +4,7 @@ scons: *** [prog.o] Source `prog.c' not found, needed by target `prog.o'. scons: internal stack trace: File "bootstrap/src/engine/SCons/Job.py", line 199, in start task.prepare() - File "bootstrap/src/engine/SCons/Script/Main.py", line 190, in prepare + File "bootstrap/src/engine/SCons/Script/Main.py", line 191, in prepare return SCons.Taskmaster.OutOfDateTask.prepare(self) File "bootstrap/src/engine/SCons/Taskmaster.py", line 198, in prepare executor.prepare() diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen index 9bed358..d71387e 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"> @@ -121,11 +121,11 @@ env.other_method_name('another arg') This function adds a new command-line option to be recognized. The specified <varname>arguments</varname> -are the same as supported by the standard Python -<function>optparse.add_option</function>() -method (with a few additional capabilities noted below); +are the same as supported by the <function>add_option</function> +method in the standard Python library module <emphasis>optparse</emphasis>, +with a few additional capabilities noted below; see the documentation for -<literal>optparse</literal> +<emphasis>optparse</emphasis> for a thorough discussion of its option-processing capabities. </para> @@ -166,23 +166,36 @@ the option will have a default value of </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> +Unlike regular <emphasis>optparse</emphasis>, option names +added via <function>AddOption</function> must be matched +exactly, the automatic matching of abbreviations on the +command line for long options is not supported. +To allow specific abbreviations, +include them in the <function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> call. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> Once a new command-line option has been added with <function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>, the option value may be accessed using <function xmlns="http://www.scons.org/dbxsd/v1.0">GetOption</function> or <function>env.GetOption</function>(). +<!-- The value may also be set, using -<function xmlns="http://www.scons.org/dbxsd/v1.0">SetOption</function> +&f-SetOption; or <function>env.SetOption</function>(), if conditions in a -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +&SConscript; require overriding any default value. Note, however, that a value specified on the command line will <emphasis>always</emphasis> override a value set by any SConscript file. +--> +<function xmlns="http://www.scons.org/dbxsd/v1.0">SetOption</function> is not currently supported for +options added with <function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>. </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -221,6 +234,22 @@ 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>add_option</function>, +from the <emphasis>optparse</emphasis> module, +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 an <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 +270,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 +300,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 +475,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"> @@ -532,30 +563,6 @@ env.AppendUnique(CCFLAGS = '-g', FOO = ['foo.yyy']) </example_commands> </listitem> </varlistentry> - <varlistentry id="f-BuildDir"> - <term> - <literal>BuildDir(build_dir, src_dir, [duplicate])</literal> - </term> - <term> - <literal>env.BuildDir(build_dir, src_dir, [duplicate])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Deprecated synonyms for -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function> -and -<function>env.VariantDir</function>(). -The -<varname>build_dir</varname> -argument becomes the -<varname>variant_dir</varname> -argument of -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function> -or -<function>env.VariantDir</function>(). -</para> -</listitem> - </varlistentry> <varlistentry id="f-Builder"> <term> <literal>Builder(action, [arguments])</literal> @@ -568,8 +575,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"> @@ -849,19 +856,29 @@ for a single special-case build. </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -As a special case, the -<varname>source_scanner</varname> -keyword argument can +<function xmlns="http://www.scons.org/dbxsd/v1.0">Command</function> builder accepts +<varname>source_scanner</varname>, +<varname>target_scanner</varname>, +<varname>source_factory</varname>, and +<varname>target_factory</varname> +keyword arguments. The *_scanner args can be used to specify a Scanner object -that will be used to scan the sources. -(The global +that will be used to apply a custom +scanner for a source or target. +For example, the global <literal>DirScanner</literal> object can be used if any of the sources will be directories that must be scanned on-disk for changes to files that aren't -already specified in other Builder of function calls.) +already specified in other Builder of function calls. +The *_factory args take a factory function that the +Command will use to turn any sources or targets +specified as strings into SCons Nodes. +See the sections "Builder Objects" +below, for more information about how these +args work in a Builder. </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> @@ -1262,15 +1279,21 @@ see below. </varlistentry> <varlistentry id="f-DefaultEnvironment"> <term> - <literal>DefaultEnvironment([args])</literal> + <literal>DefaultEnvironment([**kwargs])</literal> </term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -Creates and returns a default construction environment object. -This construction environment is used internally by SCons -in order to execute many of the global functions in this list, -and to fetch source files transparently +Creates and returns the default <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal> object. +The default <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal> is used internally by SCons +in order to execute many of the global functions in this list +(i.e. those not called as methods of a specific +<literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>), and to fetch source files transparently from source code management systems. +The default environment is a singleton, so the keyword +arguments affect it only on the first call, on subsequent +calls the already-constructed object is returned. +The default environment can be modified in the same way +as any <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>. </para> </listitem> </varlistentry> @@ -1333,11 +1356,11 @@ env.Depends(bar, installed_lib) <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> Returns a dictionary object -containing copies of all of the -construction variables in the environment. -If there are any variable names specified, -only the specified construction -variables are returned in the dictionary. +containing the <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction variables</literal> in the <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>. +If there are any arguments specified, +the values of the specified <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction variables</literal> +are returned as a string (if one +argument) or as a list of strings. </para> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -1345,8 +1368,8 @@ Example: </para> <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -dict = env.Dictionary() -cc_dict = env.Dictionary('CC', 'CCFLAGS', 'CCCOM') +cvars = env.Dictionary() +cc_values = env.Dictionary('CC', 'CCFLAGS', 'CCCOM') </example_commands> </listitem> </varlistentry> @@ -1385,7 +1408,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> @@ -1408,7 +1432,7 @@ This SConstruct: <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> env=Environment() -print env.Dump('CCCOM') +print(env.Dump('CCCOM')) </example_commands> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -1425,7 +1449,7 @@ While this SConstruct: <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> env=Environment() -print env.Dump() +print(env.Dump()) </example_commands> <para xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -1528,8 +1552,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 +1710,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 +2861,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> @@ -2955,6 +2980,7 @@ and added to the following construction variables: -fmerge-all-constants CCFLAGS, LINKFLAGS -fopenmp CCFLAGS, LINKFLAGS -include CCFLAGS +-imacros CCFLAGS -isysroot CCFLAGS, LINKFLAGS -isystem CCFLAGS -iquote CCFLAGS @@ -3539,8 +3565,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 +4255,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> @@ -4462,7 +4387,7 @@ Example: </para> <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -print env.subst("The C compiler is: $CC") +print(env.subst("The C compiler is: $CC")) def compile(target, source, env): sourceDir = env.subst("${SOURCE.srcdir}", @@ -4492,170 +4417,15 @@ Examples: </para> <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -# makes sure the built library will be installed with 0644 file +# makes sure the built library will be installed with 0o644 file # access mode -Tag( Library( 'lib.c' ), UNIX_ATTR="0644" ) +Tag( Library( 'lib.c' ), UNIX_ATTR="0o644" ) # marks file2.txt to be a documentation file 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 +4719,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> diff --git a/doc/generated/functions.mod b/doc/generated/functions.mod index e460aaf..3d49229 100644 --- a/doc/generated/functions.mod +++ b/doc/generated/functions.mod @@ -19,7 +19,6 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-Append "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Append</function>"> <!ENTITY f-AppendENVPath "<function xmlns='http://www.scons.org/dbxsd/v1.0'>AppendENVPath</function>"> <!ENTITY f-AppendUnique "<function xmlns='http://www.scons.org/dbxsd/v1.0'>AppendUnique</function>"> -<!ENTITY f-BuildDir "<function xmlns='http://www.scons.org/dbxsd/v1.0'>BuildDir</function>"> <!ENTITY f-Builder "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Builder</function>"> <!ENTITY f-CacheDir "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CacheDir</function>"> <!ENTITY f-Clean "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Clean</function>"> @@ -82,11 +81,9 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-SetOption "<function xmlns='http://www.scons.org/dbxsd/v1.0'>SetOption</function>"> <!ENTITY f-SideEffect "<function xmlns='http://www.scons.org/dbxsd/v1.0'>SideEffect</function>"> <!ENTITY f-SourceCode "<function xmlns='http://www.scons.org/dbxsd/v1.0'>SourceCode</function>"> -<!ENTITY f-SourceSignatures "<function xmlns='http://www.scons.org/dbxsd/v1.0'>SourceSignatures</function>"> <!ENTITY f-Split "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Split</function>"> <!ENTITY f-subst "<function xmlns='http://www.scons.org/dbxsd/v1.0'>subst</function>"> <!ENTITY f-Tag "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Tag</function>"> -<!ENTITY f-TargetSignatures "<function xmlns='http://www.scons.org/dbxsd/v1.0'>TargetSignatures</function>"> <!ENTITY f-Tool "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Tool</function>"> <!ENTITY f-Value "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Value</function>"> <!ENTITY f-VariantDir "<function xmlns='http://www.scons.org/dbxsd/v1.0'>VariantDir</function>"> @@ -103,7 +100,6 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-env-Append "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Append</function>"> <!ENTITY f-env-AppendENVPath "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.AppendENVPath</function>"> <!ENTITY f-env-AppendUnique "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.AppendUnique</function>"> -<!ENTITY f-env-BuildDir "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.BuildDir</function>"> <!ENTITY f-env-Builder "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Builder</function>"> <!ENTITY f-env-CacheDir "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.CacheDir</function>"> <!ENTITY f-env-Clean "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Clean</function>"> @@ -166,11 +162,9 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-env-SetOption "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.SetOption</function>"> <!ENTITY f-env-SideEffect "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.SideEffect</function>"> <!ENTITY f-env-SourceCode "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.SourceCode</function>"> -<!ENTITY f-env-SourceSignatures "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.SourceSignatures</function>"> <!ENTITY f-env-Split "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Split</function>"> <!ENTITY f-env-subst "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.subst</function>"> <!ENTITY f-env-Tag "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Tag</function>"> -<!ENTITY f-env-TargetSignatures "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.TargetSignatures</function>"> <!ENTITY f-env-Tool "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Tool</function>"> <!ENTITY f-env-Value "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Value</function>"> <!ENTITY f-env-VariantDir "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.VariantDir</function>"> @@ -197,7 +191,6 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-link-Append "<link linkend='f-Append' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Append</function></link>"> <!ENTITY f-link-AppendENVPath "<link linkend='f-AppendENVPath' xmlns='http://www.scons.org/dbxsd/v1.0'><function>AppendENVPath</function></link>"> <!ENTITY f-link-AppendUnique "<link linkend='f-AppendUnique' xmlns='http://www.scons.org/dbxsd/v1.0'><function>AppendUnique</function></link>"> -<!ENTITY f-link-BuildDir "<link linkend='f-BuildDir' xmlns='http://www.scons.org/dbxsd/v1.0'><function>BuildDir</function></link>"> <!ENTITY f-link-Builder "<link linkend='f-Builder' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Builder</function></link>"> <!ENTITY f-link-CacheDir "<link linkend='f-CacheDir' xmlns='http://www.scons.org/dbxsd/v1.0'><function>CacheDir</function></link>"> <!ENTITY f-link-Clean "<link linkend='f-Clean' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Clean</function></link>"> @@ -260,11 +253,9 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-link-SetOption "<link linkend='f-SetOption' xmlns='http://www.scons.org/dbxsd/v1.0'><function>SetOption</function></link>"> <!ENTITY f-link-SideEffect "<link linkend='f-SideEffect' xmlns='http://www.scons.org/dbxsd/v1.0'><function>SideEffect</function></link>"> <!ENTITY f-link-SourceCode "<link linkend='f-SourceCode' xmlns='http://www.scons.org/dbxsd/v1.0'><function>SourceCode</function></link>"> -<!ENTITY f-link-SourceSignatures "<link linkend='f-SourceSignatures' xmlns='http://www.scons.org/dbxsd/v1.0'><function>SourceSignatures</function></link>"> <!ENTITY f-link-Split "<link linkend='f-Split' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Split</function></link>"> <!ENTITY f-link-subst "<link linkend='f-subst' xmlns='http://www.scons.org/dbxsd/v1.0'><function>subst</function></link>"> <!ENTITY f-link-Tag "<link linkend='f-Tag' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Tag</function></link>"> -<!ENTITY f-link-TargetSignatures "<link linkend='f-TargetSignatures' xmlns='http://www.scons.org/dbxsd/v1.0'><function>TargetSignatures</function></link>"> <!ENTITY f-link-Tool "<link linkend='f-Tool' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Tool</function></link>"> <!ENTITY f-link-Value "<link linkend='f-Value' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Value</function></link>"> <!ENTITY f-link-VariantDir "<link linkend='f-VariantDir' xmlns='http://www.scons.org/dbxsd/v1.0'><function>VariantDir</function></link>"> @@ -281,7 +272,6 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-link-env-Append "<link linkend='f-Append' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Append</function></link>"> <!ENTITY f-link-env-AppendENVPath "<link linkend='f-AppendENVPath' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.AppendENVPath</function></link>"> <!ENTITY f-link-env-AppendUnique "<link linkend='f-AppendUnique' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.AppendUnique</function></link>"> -<!ENTITY f-link-env-BuildDir "<link linkend='f-BuildDir' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.BuildDir</function></link>"> <!ENTITY f-link-env-Builder "<link linkend='f-Builder' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Builder</function></link>"> <!ENTITY f-link-env-CacheDir "<link linkend='f-CacheDir' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.CacheDir</function></link>"> <!ENTITY f-link-env-Clean "<link linkend='f-Clean' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Clean</function></link>"> @@ -344,11 +334,9 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-link-env-SetOption "<link linkend='f-SetOption' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.SetOption</function></link>"> <!ENTITY f-link-env-SideEffect "<link linkend='f-SideEffect' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.SideEffect</function></link>"> <!ENTITY f-link-env-SourceCode "<link linkend='f-SourceCode' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.SourceCode</function></link>"> -<!ENTITY f-link-env-SourceSignatures "<link linkend='f-SourceSignatures' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.SourceSignatures</function></link>"> <!ENTITY f-link-env-Split "<link linkend='f-Split' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Split</function></link>"> <!ENTITY f-link-env-subst "<link linkend='f-subst' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.subst</function></link>"> <!ENTITY f-link-env-Tag "<link linkend='f-Tag' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Tag</function></link>"> -<!ENTITY f-link-env-TargetSignatures "<link linkend='f-TargetSignatures' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.TargetSignatures</function></link>"> <!ENTITY f-link-env-Tool "<link linkend='f-Tool' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Tool</function></link>"> <!ENTITY f-link-env-Value "<link linkend='f-Value' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Value</function></link>"> <!ENTITY f-link-env-VariantDir "<link linkend='f-VariantDir' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.VariantDir</function></link>"> diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen index ecd9c98..0d30f6f 100644 --- a/doc/generated/tools.gen +++ b/doc/generated/tools.gen @@ -91,7 +91,7 @@ Sets construction variables for the bcc32 compiler. <term>cc</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for generic POSIX C copmilers. +Sets construction variables for generic POSIX C compilers. </para> <para>Sets: &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CCFLAGS;, &cv-link-CFILESUFFIX;, &cv-link-CFLAGS;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-FRAMEWORKPATH;, &cv-link-FRAMEWORKS;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-SHCC;, &cv-link-SHCCCOM;, &cv-link-SHCCFLAGS;, &cv-link-SHCFLAGS;, &cv-link-SHOBJSUFFIX;.</para><para>Uses: &cv-link-PLATFORM;.</para></listitem> </varlistentry> @@ -139,9 +139,91 @@ Set construction variables for cygwin linker/loader. <term>default</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets variables by calling a default list of Tool modules -for the platform on which SCons is running. +Sets <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction variables</literal> for a default list of Tool modules. +Use <emphasis role="bold">default</emphasis> +in the tools list to retain the original defaults, +since the <parameter>tools</parameter> parameter +is treated as a literal statement of the tools +to be made available in that <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>, not an addition. </para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +The list of tools selected by default is not static, +but is dependent both on +the platform and on the software installed on the platform. +Some tools will not initialize if an underlying command is +not found, and some tools are selected from a list of choices +on a first-found basis. The finished tool list can be +examined by inspecting the <envar>TOOLS</envar> <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction variable</literal> +in the <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +On all platforms, all tools from the following list +are selected whose respective conditions are met: +filesystem, wix, lex, yacc, rpcgen, swig, +jar, javac, javah, rmic, dvipdf, dvips, gs, +tex, latex, pdflatex, pdftex, tar, zip, textfile. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +On Linux systems, the default tools list selects +(first-found): a C compiler from +gcc, intelc, icc, cc; +a C++ compiler from +g++, intelc, icc, cxx; +an assembler from +gas, nasm, masm; +a linker from +gnulink, ilink; +a Fortran compiler from +gfortran, g77, ifort, ifl, f95, f90, f77; +and a static archiver 'ar'. +It also selects all found from the list +m4, rpm. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +On Windows systems, the default tools list selects +(first-found): a C compiler from +msvc, mingw, gcc, intelc, icl, icc, cc, bcc32; +a C++ compiler from +msvc, intelc, icc, g++, cxx, bcc32; +an assembler from +masm, nasm, gas, 386asm; +a linker from +mslink, gnulink, ilink, linkloc, ilink32; +a Fortran compiler from +gfortran, g77, ifl, cvf, f95, f90, fortran; +and a static archiver from +mslib, ar, tlib; +It also selects all found from the list +msvs, midl. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +On MacOS systems, the default tools list selects +(first-found): a C compiler from +gcc, cc; +a C++ compiler from +g++, cxx; +an assembler 'as'; +a linker from +applelink, gnulink; +a Fortran compiler from +gfortran, f95, f90, g77; +and a static archiver ar. +It also selects all found from the list +m4, rpm. +</para> + +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +Default lists for other platforms can be found by +examining the <filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +source code (see +<filename>SCons/Tool/__init__.py</filename>). +</para> + </listitem> </varlistentry> <varlistentry id="t-dmd"> @@ -627,7 +709,9 @@ Sets construction variables for the <application xmlns="http://www.scons.org/dbx <term>link</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for generic POSIX linkers. +Sets construction variables for generic POSIX linkers. This is +a "smart" linker tool which selects a compiler to complete the linking +based on the types of source files. </para> <para>Sets: &cv-link-LDMODULE;, &cv-link-LDMODULECOM;, &cv-link-LDMODULEFLAGS;, &cv-link-LDMODULENOVERSIONSYMLINKS;, &cv-link-LDMODULEPREFIX;, &cv-link-LDMODULESUFFIX;, &cv-link-LDMODULEVERSION;, &cv-link-LDMODULEVERSIONFLAGS;, &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-__LDMODULEVERSIONFLAGS;, &cv-link-__SHLIBVERSIONFLAGS;.</para><para>Uses: &cv-link-LDMODULECOMSTR;, &cv-link-LINKCOMSTR;, &cv-link-SHLINKCOMSTR;.</para></listitem> </varlistentry> diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen index 3f26933..9050832 100644 --- a/doc/generated/variables.gen +++ b/doc/generated/variables.gen @@ -488,7 +488,8 @@ after the SCons template for the file has been written. <para xmlns="http://www.scons.org/dbxsd/v1.0"> A reserved variable name that may not be set or used in a construction environment. -(See "Variable Substitution," below.) +(See the manpage section "Variable Substitution" +for more information). </para> </listitem> </varlistentry> @@ -498,7 +499,8 @@ that may not be set or used in a construction environment. <para xmlns="http://www.scons.org/dbxsd/v1.0"> A reserved variable name that may not be set or used in a construction environment. -(See "Variable Substitution," below.) +(See the manpage section "Variable Substitution" +for more information). </para> </listitem> </varlistentry> @@ -874,35 +876,15 @@ depending on the specific C++ compiler being used. <para xmlns="http://www.scons.org/dbxsd/v1.0"> The D compiler to use. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The D compiler to use. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The D compiler to use. -</para> </listitem> </varlistentry> <varlistentry id="cv-DCOM"> <term>DCOM</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line used to compile a D file to an object file. - Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-DFLAGS"><envar>$DFLAGS</envar></link> construction variable - is included on this command line. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line used to compile a D file to an object file. - Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-DFLAGS"><envar>$DFLAGS</envar></link> construction variable - is included on this command line. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line used to compile a D file to an object file. - Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-DFLAGS"><envar>$DFLAGS</envar></link> construction variable - is included on this command line. +The command line used to compile a D file to an object file. +Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-DFLAGS"><envar>$DFLAGS</envar></link> construction variable +is included on this command line. </para> </listitem> </varlistentry> @@ -910,49 +892,25 @@ The D compiler to use. <term>DDEBUG</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - List of debug tags to enable when compiling. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - List of debug tags to enable when compiling. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - List of debug tags to enable when compiling. +List of debug tags to enable when compiling. </para> </listitem> </varlistentry> <varlistentry id="cv-DDEBUGPREFIX"> <term>DDEBUGPREFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DDEBUGPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DDEBUGPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DDEBUGPREFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DDEBUGPREFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DDEBUGSUFFIX"> <term>DDEBUGSUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DDEBUGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DDEBUGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DDEBUGSUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DDEBUGSUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DESCRIPTION"> <term>DESCRIPTION</term> @@ -980,98 +938,50 @@ section of an RPM <varlistentry id="cv-DFILESUFFIX"> <term>DFILESUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DFILESUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DFILESUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DFILESUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DFILESUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DFLAGPREFIX"> <term>DFLAGPREFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DFLAGPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DFLAGPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DFLAGPREFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DFLAGPREFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DFLAGS"> <term>DFLAGS</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - General options that are passed to the D compiler. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - General options that are passed to the D compiler. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - General options that are passed to the D compiler. +General options that are passed to the D compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-DFLAGSUFFIX"> <term>DFLAGSUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DFLAGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DFLAGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DFLAGSUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DFLAGSUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DINCPREFIX"> <term>DINCPREFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DINCPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DINCPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DINCPREFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DINCPREFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DINCSUFFIX"> <term>DINCSUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBFLAGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBFLAGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBFLAGSUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DLIBFLAGSUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-Dir"> <term>Dir</term> @@ -1100,15 +1010,7 @@ into a list of Dir instances relative to the target being built. <term>DLIB</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - Name of the lib tool to use for D codes. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - Name of the lib tool to use for D codes. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - Name of the lib tool to use for D codes. +Name of the lib tool to use for D codes. </para> </listitem> </varlistentry> @@ -1116,127 +1018,63 @@ into a list of Dir instances relative to the target being built. <term>DLIBCOM</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when creating libraries. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when creating libraries. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when creating libraries. +The command line to use when creating libraries. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBDIRPREFIX"> <term>DLIBDIRPREFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKPREFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DLIBLINKPREFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DLIBDIRSUFFIX"> <term>DLIBDIRSUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKSUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DLIBLINKSUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DLIBFLAGPREFIX"> <term>DLIBFLAGPREFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBFLAGPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBFLAGPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBFLAGPREFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DLIBFLAGPREFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DLIBFLAGSUFFIX"> <term>DLIBFLAGSUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBFLAGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBFLAGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBFLAGSUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DLIBFLAGSUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DLIBLINKPREFIX"> <term>DLIBLINKPREFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKPREFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DLIBLINKPREFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DLIBLINKSUFFIX"> <term>DLIBLINKSUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLIBLINKSUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DLIBLINKSUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DLINK"> <term>DLINK</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - Name of the linker to use for linking systems including D sources. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - Name of the linker to use for linking systems including D sources. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - Name of the linker to use for linking systems including D sources. +Name of the linker to use for linking systems including D sources. </para> </listitem> </varlistentry> @@ -1244,33 +1082,17 @@ into a list of Dir instances relative to the target being built. <term>DLINKCOM</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when linking systems including D sources. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when linking systems including D sources. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when linking systems including D sources. +The command line to use when linking systems including D sources. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINKFLAGPREFIX"> <term>DLINKFLAGPREFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLINKFLAGPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLINKFLAGPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLINKFLAGPREFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DLINKFLAGPREFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DLINKFLAGS"> <term>DLINKFLAGS</term> @@ -1278,31 +1100,15 @@ into a list of Dir instances relative to the target being built. <para xmlns="http://www.scons.org/dbxsd/v1.0"> List of linker flags. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -List of linker flags. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -List of linker flags. -</para> </listitem> </varlistentry> <varlistentry id="cv-DLINKFLAGSUFFIX"> <term>DLINKFLAGSUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLINKFLAGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLINKFLAGSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DLINKFLAGSUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DLINKFLAGSUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_EPUB"> <term>DOCBOOK_DEFAULT_XSL_EPUB</term> @@ -1507,39 +1313,31 @@ for <literal>saxon</literal> and <literal>saxon-xslt</literal>, respectively. <para xmlns="http://www.scons.org/dbxsd/v1.0"> List of paths to search for import modules. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - List of paths to search for import modules. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - List of paths to search for import modules. -</para> </listitem> </varlistentry> <varlistentry id="cv-DRPATHPREFIX"> <term>DRPATHPREFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DRPATHPREFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DRPATHPREFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DRPATHSUFFIX"> <term>DRPATHSUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DRPATHSUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DRPATHSUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DShLibSonameGenerator"> <term>DShLibSonameGenerator</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DShLibSonameGenerator. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DShLibSonameGenerator. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DSUFFIXES"> <term>DSUFFIXES</term> @@ -1558,50 +1356,26 @@ The default list is: <varlistentry id="cv-DVERPREFIX"> <term>DVERPREFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DVERPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DVERPREFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DVERPREFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DVERPREFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DVERSIONS"> <term>DVERSIONS</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - List of version tags to enable when compiling. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - List of version tags to enable when compiling. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - List of version tags to enable when compiling. +List of version tags to enable when compiling. </para> </listitem> </varlistentry> <varlistentry id="cv-DVERSUFFIX"> <term>DVERSUFFIX</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DVERSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DVERSUFFIX. - </para> - - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - DVERSUFFIX. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +DVERSUFFIX. +</para> +</listitem> </varlistentry> <varlistentry id="cv-DVIPDF"> <term>DVIPDF</term> @@ -3128,7 +2902,7 @@ to <literal>'.dll'</literal>. Used to override <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link>/<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> when generating versioned import library for a shared library/loadable module. If undefined, the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link>/<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> is used to -determine the version of versioned import library. +determine the version of versioned import library. </para> </listitem> </varlistentry> @@ -3298,7 +3072,7 @@ The command line used to call the Java archive tool. <para xmlns="http://www.scons.org/dbxsd/v1.0"> The string displayed when the Java archive tool is called -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JARCOM"><envar>$JARCOM</envar></link> (the command line) is displayed. +If this is not set, then <envar xmlns="http://www.scons.org/dbxsd/v1.0">$JARCOM</envar> (the command line) is displayed. </para> <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -3308,7 +3082,7 @@ env = Environment(JARCOMSTR = "JARchiving $SOURCES into $TARGET") <para xmlns="http://www.scons.org/dbxsd/v1.0"> The string displayed when the Java archive tool is called -If this is not set, then <envar xmlns="http://www.scons.org/dbxsd/v1.0">$JARCOM</envar> (the command line) is displayed. +If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JARCOM"><envar>$JARCOM</envar></link> (the command line) is displayed. </para> <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> @@ -3674,6 +3448,17 @@ If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend=" </para> </listitem> </varlistentry> + <varlistentry id="cv-LDMODULEEMITTER"> + <term>LDMODULEEMITTER</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +Contains the emitter specification for the +<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-LoadableModule"><function>LoadableModule</function></link> builder. +The manpage section "Builder Objects" contains +general information on specifying emitters. +</para> +</listitem> + </varlistentry> <varlistentry id="cv-LDMODULEFLAGS"> <term>LDMODULEFLAGS</term> <listitem> @@ -3846,7 +3631,10 @@ when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBDIRFLAGS</envar> va <term>LIBEMITTER</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -TODO +Contains the emitter specification for the +<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-StaticLibrary"><function>StaticLibrary</function></link> builder. +The manpage section "Builder Objects" contains +general information on specifying emitters. </para> </listitem> </varlistentry> @@ -4239,7 +4027,7 @@ The command line used to pass files to the Microsoft IDL compiler. <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> The string displayed when -the Microsoft IDL copmiler is called. +the Microsoft IDL compiler is called. If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MIDLCOM"><envar>$MIDLCOM</envar></link> (the command line) is displayed. </para> </listitem> @@ -5336,7 +5124,10 @@ for example. <term>PROGEMITTER</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -TODO +Contains the emitter specification for the +<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Program"><function>Program</function></link> builder. +The manpage section "Builder Objects" contains +general information on specifying emitters. </para> </listitem> </varlistentry> @@ -6031,9 +5822,9 @@ appending to this list, although the more flexible approach is to associate scanners with a specific Builder. -See the sections "Builder Objects" -and "Scanner Objects," -below, for more information. +See the manpage sections "Builder Objects" +and "Scanner Objects" +for more information. </para> </listitem> </varlistentry> @@ -6149,18 +5940,8 @@ to generate shared-library objects. <term>SHDC</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The name of the compiler to use when compiling D source - destined to be in a shared objects. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The name of the compiler to use when compiling D source - destined to be in a shared objects. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The name of the compiler to use when compiling D source - destined to be in a shared objects. +The name of the compiler to use when compiling D source +destined to be in a shared objects. </para> </listitem> </varlistentry> @@ -6168,50 +5949,32 @@ to generate shared-library objects. <term>SHDCOM</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when compiling code to be part of shared objects. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when compiling code to be part of shared objects. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when compiling code to be part of shared objects. +The command line to use when compiling code to be part of shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDLIBVERSION"> <term>SHDLIBVERSION</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - SHDLIBVERSION. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +SHDLIBVERSION. +</para> +</listitem> </varlistentry> <varlistentry id="cv-SHDLIBVERSIONFLAGS"> <term>SHDLIBVERSIONFLAGS</term> <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - SHDLIBVERSIONFLAGS. - </para> - </listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +SHDLIBVERSIONFLAGS. +</para> +</listitem> </varlistentry> <varlistentry id="cv-SHDLINK"> <term>SHDLINK</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The linker to use when creating shared objects for code bases - include D sources. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The linker to use when creating shared objects for code bases - include D sources. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The linker to use when creating shared objects for code bases - include D sources. +The linker to use when creating shared objects for code bases +include D sources. </para> </listitem> </varlistentry> @@ -6219,15 +5982,7 @@ to generate shared-library objects. <term>SHDLINKCOM</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when generating shared objects. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when generating shared objects. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The command line to use when generating shared objects. +The command line to use when generating shared objects. </para> </listitem> </varlistentry> @@ -6235,15 +5990,7 @@ to generate shared-library objects. <term>SHDLINKFLAGS</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The list of flags to use when generating a shared object. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The list of flags to use when generating a shared object. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - The list of flags to use when generating a shared object. +The list of flags to use when generating a shared object. </para> </listitem> </varlistentry> @@ -6737,7 +6484,10 @@ If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend=" <term>SHLIBEMITTER</term> <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> -TODO +Contains the emitter specification for the +<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder. +The manpage section "Builder Objects" contains +general information on specifying emitters. </para> </listitem> </varlistentry> @@ -6781,7 +6531,7 @@ The suffix used for shared library file names. <listitem> <para xmlns="http://www.scons.org/dbxsd/v1.0"> When this construction variable is defined, a versioned shared library -is created by <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder. This activates the +is created by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder. This activates the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_SHLIBVERSIONFLAGS"><envar>$_SHLIBVERSIONFLAGS</envar></link> and thus modifies the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> as required, adds the version number to the library name, and creates the symlinks that are needed. <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> versions should exist as alpha-numeric, @@ -6790,16 +6540,6 @@ Example <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"> </para> </listitem> </varlistentry> - <varlistentry id="cv-SHLIBVERSIONFLAGS"> - <term>SHLIBVERSIONFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Extra flags added to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> when building versioned -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link>. These flags are only used when <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> is -set. -</para> -</listitem> - </varlistentry> <varlistentry id="cv-_SHLIBVERSIONFLAGS"> <term>_SHLIBVERSIONFLAGS</term> <listitem> @@ -6813,6 +6553,16 @@ and some extra dynamically generated options (such as </para> </listitem> </varlistentry> + <varlistentry id="cv-SHLIBVERSIONFLAGS"> + <term>SHLIBVERSIONFLAGS</term> + <listitem> +<para xmlns="http://www.scons.org/dbxsd/v1.0"> +Extra flags added to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> when building versioned +<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link>. These flags are only used when <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> is +set. +</para> +</listitem> + </varlistentry> <varlistentry id="cv-SHLINK"> <term>SHLINK</term> <listitem> @@ -6901,7 +6651,8 @@ The variable is used, for example, by <link xmlns="http://www.scons.org/dbxsd/v1 <para xmlns="http://www.scons.org/dbxsd/v1.0"> A reserved variable name that may not be set or used in a construction environment. -(See "Variable Substitution," below.) +(See the manpage section "Variable Substitution" +for more information). </para> </listitem> </varlistentry> @@ -6924,7 +6675,8 @@ field in the controlling information for Ipkg and RPM packages. <para xmlns="http://www.scons.org/dbxsd/v1.0"> A reserved variable name that may not be set or used in a construction environment. -(See "Variable Substitution," below.) +(See the manpage section "Variable Substitution" +for more information). </para> </listitem> </varlistentry> @@ -7268,7 +7020,8 @@ General options passed to the tar archiver. <para xmlns="http://www.scons.org/dbxsd/v1.0"> A reserved variable name that may not be set or used in a construction environment. -(See "Variable Substitution," below.) +(See the manpage section "Variable Substitution" +for more information). </para> </listitem> </varlistentry> @@ -7332,7 +7085,8 @@ For example, if you want to compile 64-bit binaries, you would set <para xmlns="http://www.scons.org/dbxsd/v1.0"> A reserved variable name that may not be set or used in a construction environment. -(See "Variable Substitution," below.) +(See the manpage section "Variable Substitution" +for more information). </para> </listitem> </varlistentry> @@ -7465,7 +7219,8 @@ that are part of this construction environment. <para xmlns="http://www.scons.org/dbxsd/v1.0"> A reserved variable name that may not be set or used in a construction environment. -(See "Variable Substitution," below.) +(See the manpage section "Variable Substitution" +for more information). </para> </listitem> </varlistentry> @@ -7475,7 +7230,8 @@ that may not be set or used in a construction environment. <para xmlns="http://www.scons.org/dbxsd/v1.0"> A reserved variable name that may not be set or used in a construction environment. -(See "Variable Substitution," below.) +(See the manpage section "Variable Substitution" +for more information). </para> </listitem> </varlistentry> diff --git a/doc/generated/variables.mod b/doc/generated/variables.mod index 372a15f..ba92aa9 100644 --- a/doc/generated/variables.mod +++ b/doc/generated/variables.mod @@ -251,6 +251,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-LDMODULE "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULE</envar>"> <!ENTITY cv-LDMODULECOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULECOM</envar>"> <!ENTITY cv-LDMODULECOMSTR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULECOMSTR</envar>"> +<!ENTITY cv-LDMODULEEMITTER "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULEEMITTER</envar>"> <!ENTITY cv-LDMODULEFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULEFLAGS</envar>"> <!ENTITY cv-LDMODULENOVERSIONSYMLINKS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULENOVERSIONSYMLINKS</envar>"> <!ENTITY cv-LDMODULEPREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULEPREFIX</envar>"> @@ -504,8 +505,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-_SHLIBSONAME "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_SHLIBSONAME</envar>"> <!ENTITY cv-SHLIBSUFFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$SHLIBSUFFIX</envar>"> <!ENTITY cv-SHLIBVERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$SHLIBVERSION</envar>"> -<!ENTITY cv-SHLIBVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$SHLIBVERSIONFLAGS</envar>"> <!ENTITY cv-_SHLIBVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_SHLIBVERSIONFLAGS</envar>"> +<!ENTITY cv-SHLIBVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$SHLIBVERSIONFLAGS</envar>"> <!ENTITY cv-SHLINK "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$SHLINK</envar>"> <!ENTITY cv-SHLINKCOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$SHLINKCOM</envar>"> <!ENTITY cv-SHLINKCOMSTR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$SHLINKCOMSTR</envar>"> @@ -891,6 +892,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-link-LDMODULE "<link linkend='cv-LDMODULE' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULE</envar></link>"> <!ENTITY cv-link-LDMODULECOM "<link linkend='cv-LDMODULECOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULECOM</envar></link>"> <!ENTITY cv-link-LDMODULECOMSTR "<link linkend='cv-LDMODULECOMSTR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULECOMSTR</envar></link>"> +<!ENTITY cv-link-LDMODULEEMITTER "<link linkend='cv-LDMODULEEMITTER' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULEEMITTER</envar></link>"> <!ENTITY cv-link-LDMODULEFLAGS "<link linkend='cv-LDMODULEFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULEFLAGS</envar></link>"> <!ENTITY cv-link-LDMODULENOVERSIONSYMLINKS "<link linkend='cv-LDMODULENOVERSIONSYMLINKS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULENOVERSIONSYMLINKS</envar></link>"> <!ENTITY cv-link-LDMODULEPREFIX "<link linkend='cv-LDMODULEPREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULEPREFIX</envar></link>"> @@ -1144,8 +1146,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-link-_SHLIBSONAME "<link linkend='cv-_SHLIBSONAME' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_SHLIBSONAME</envar></link>"> <!ENTITY cv-link-SHLIBSUFFIX "<link linkend='cv-SHLIBSUFFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$SHLIBSUFFIX</envar></link>"> <!ENTITY cv-link-SHLIBVERSION "<link linkend='cv-SHLIBVERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$SHLIBVERSION</envar></link>"> -<!ENTITY cv-link-SHLIBVERSIONFLAGS "<link linkend='cv-SHLIBVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$SHLIBVERSIONFLAGS</envar></link>"> <!ENTITY cv-link-_SHLIBVERSIONFLAGS "<link linkend='cv-_SHLIBVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_SHLIBVERSIONFLAGS</envar></link>"> +<!ENTITY cv-link-SHLIBVERSIONFLAGS "<link linkend='cv-SHLIBVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$SHLIBVERSIONFLAGS</envar></link>"> <!ENTITY cv-link-SHLINK "<link linkend='cv-SHLINK' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$SHLINK</envar></link>"> <!ENTITY cv-link-SHLINKCOM "<link linkend='cv-SHLINKCOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$SHLINKCOM</envar></link>"> <!ENTITY cv-link-SHLINKCOMSTR "<link linkend='cv-SHLINKCOMSTR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$SHLINKCOMSTR</envar></link>"> |