diff options
author | William Deegan <bill@baddogconsulting.com> | 2021-11-16 18:55:47 +0000 |
---|---|---|
committer | William Deegan <bill@baddogconsulting.com> | 2021-11-16 18:55:47 +0000 |
commit | 6ef89cb024b01eee7debce6efb856437dd4e4372 (patch) | |
tree | ff43883280da87f36fd6a37e87524dc0349c49be /doc/generated/variables.gen | |
parent | 02f4075bf491267bbc872587d9845086560fc6b1 (diff) | |
download | scons-git-6ef89cb024b01eee7debce6efb856437dd4e4372.tar.gz |
Updated docs for 4.2.0 release
Diffstat (limited to 'doc/generated/variables.gen')
-rw-r--r-- | doc/generated/variables.gen | 406 |
1 files changed, 185 insertions, 221 deletions
diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen index 8c170849d..cf7751f1f 100644 --- a/doc/generated/variables.gen +++ b/doc/generated/variables.gen @@ -3092,49 +3092,52 @@ is <quote><literal>-dNOPAUSE -dBATCH -sDEVICE=pdfwrite</literal></quote> <envar>HOST_ARCH</envar> </term> <listitem><para> - The name of the host hardware architecture. - Can be set when creating a &consenv; by passing as a keyword - argument in the &f-link-Environment; call; should not be - changed otherwise. - If not specified in the &f-Environment; call, will be set to - the defaults for the particular platform, which is in turn - auto-detected unless the <parameter>platform</parameter> - argument to &f-Environment; is given. - Note the detected value of the architecture may not be identical to - that from the &Python; <systemitem>platform.machine</systemitem> method. -</para> -<para> - On the Windows platform, if the Microsoft Visual C++ compiler - is available, &t-link-msvc; tool setup is done using - &cv-HOST_ARCH; and &cv-link-TARGET_ARCH;. Changing the values at - any later time will not cause the tool to be reinitialized. - Valid values for this usage are the same as for &cv-link-TARGET_ARCH;. -</para> -<para> - On other platforms, this &consvar; is informational and does - not currently affect construction activities. -</para> - </listitem> + The name of the host hardware architecture + used to create this &consenv;. + The platform code sets this when initializing + (see &cv-link-PLATFORM; and the + <parameter>platform</parameter> argument to &f-link-Environment;). + Note the detected name of the architecture may not be identical to + that returned by the &Python; + <systemitem>platform.machine</systemitem> method. + </para> + <para> + On the <literal>win32</literal> platform, + if the Microsoft Visual C++ compiler is available, + &t-link-msvc; tool setup is done using + &cv-HOST_ARCH; and &cv-link-TARGET_ARCH;. + Changing the values at any later time will not cause + the tool to be reinitialized. + Valid host arch values are + <literal>x86</literal> and <literal>arm</literal> + for 32-bit hosts and + <literal>amd64</literal> and <literal>x86_64</literal> + for 64-bit hosts. + </para> + <para> + Should be considered immutable. + &cv-HOST_ARCH; is not currently used by other platforms, + but the option is reserved to do so in future + </para> + </listitem> </varlistentry> <varlistentry id="cv-HOST_OS"> <term> <envar>HOST_OS</envar> </term> <listitem><para> - The name of the host operating system. - Can be set when creating a &consenv; by passing as a keyword - argument in the &f-link-Environment; call; should not be - changed otherwise. - If not specified in the &f-Environment; call, will be set to - the defaults for the particular platform, which is in turn - auto-detected unless the <parameter>platform</parameter> - argument to &f-Environment; is given. -</para> -<para> - This &consvar; is informational and does not currently - affect construction activities. -</para> - </listitem> + The name of the host operating system for the platform + used to create this &consenv;. + The platform code sets this when initializing + (see &cv-link-PLATFORM; and the + <parameter>platform</parameter> argument to &f-link-Environment;). + </para> + <para> + Should be considered immutable. + &cv-HOST_OS; is not currently used by &SCons;, + but the option is reserved to do so in future + </para> + </listitem> </varlistentry> <varlistentry id="cv-IDLSUFFIXES"> <term> @@ -3670,25 +3673,30 @@ for Java classes. <envar>JAVAVERSION</envar> </term> <listitem><para> - Specifies the Java version being used by the &b-Java; builder. - This is <emphasis>not</emphasis> currently used to select one - version of the Java compiler vs. another. - Instead, you should set this to specify the version of Java - supported by your &javac; compiler. - The default is <literal>1.4</literal>. - </para> - - <para> + Specifies the Java version being used by the &b-link-Java; + builder. Set this to specify the version of Java targeted + by the &javac; compiler. This is sometimes necessary because Java 1.5 changed the file names that are created for nested anonymous inner classes, which can cause a mismatch with the files that &SCons; expects will be generated by the &javac; compiler. - Setting &cv-JAVAVERSION; to - <literal>1.5</literal> - (or <literal>1.6</literal>, as appropriate) - can make &SCons; realize that a Java 1.5 or 1.6 - build is actually up to date. + Setting &cv-JAVAVERSION; to a version greater than + <literal>1.4</literal> makes &SCons; realize that a build + with such a compiler is actually up to date. + The default is <literal>1.4</literal>. + </para> + <para> + While this is <emphasis>not</emphasis> primarily intended for + selecting one version of the Java compiler vs. another, + it does have that effect on the Windows platform. A + more precise approach is to set &cv-link-JAVAC; (and related + &consvars; for related utilities) to the path to the specific + Java compiler you want, if that is not the default compiler. + On non-Windows platforms, the + <systemitem>alternatives</systemitem> system may provide a + way to adjust the default Java compiler without + having to specify explicit paths. </para> </listitem> </varlistentry> @@ -4755,6 +4763,7 @@ constructor; setting it later has no effect. <para> Valid values for Windows are +<literal>14.3</literal>, <literal>14.2</literal>, <literal>14.1</literal>, <literal>14.1Exp</literal>, @@ -5257,6 +5266,17 @@ Specfies the name of the project to package. </para> </listitem> </varlistentry> + <varlistentry id="cv-NINJA_FORCE_SCONS_BUILD"> + <term> + <envar>NINJA_FORCE_SCONS_BUILD</envar> + </term> + <listitem><para> + When NINJA_FORCE_SCONS_BUILD is True, this will cause the build nodes to callback to scons instead of using + ninja to build them. This is intended to be passed to the environment on the builder invocation. + It is useful if you have a build node which does something which is not easily translated into ninja. + </para> + </listitem> + </varlistentry> <varlistentry id="cv-NINJA_GENERATED_SOURCE_SUFFIXES"> <term> <envar>NINJA_GENERATED_SOURCE_SUFFIXES</envar> @@ -5412,7 +5432,7 @@ Example: </para> <example_commands> -env['PCH'] = 'StdAfx.pch' +env['PCH'] = File('StdAfx.pch') </example_commands> </listitem> </varlistentry> @@ -5637,20 +5657,21 @@ The default is <envar>PLATFORM</envar> </term> <listitem><para> -The name of the platform used to create the Environment. If no platform is -specified when the Environment is created, -&scons; -autodetects the platform. -</para> + The name of the platform used to create this &consenv;. + &SCons; sets this when initializing the platform, + which by default is auto-detected + (see the <parameter>platform</parameter> + argument to &f-link-Environment;). + </para> -<example_commands> -env = Environment(tools = []) + <example_commands> +env = Environment(tools=[]) if env['PLATFORM'] == 'cygwin': Tool('mingw')(env) else: Tool('msvc')(env) -</example_commands> -</listitem> + </example_commands> + </listitem> </varlistentry> <varlistentry id="cv-POAUTOINIT"> <term> @@ -5859,8 +5880,8 @@ The prefix used for PostScript file names. <envar>QT_AUTOSCAN</envar> </term> <listitem><para> -Turn off scanning for mocable files. Use the Moc Builder to explicitly -specify files to run moc on. +Turn off scanning for mocable files. Use the &b-link-Moc; Builder to explicitly +specify files to run <command>moc</command> on. </para> </listitem> </varlistentry> @@ -5869,8 +5890,8 @@ specify files to run moc on. <envar>QT_BINPATH</envar> </term> <listitem><para> -The path where the qt binaries are installed. -The default value is '&cv-link-QTDIR;/bin'. +The path where the Qt binaries are installed. +The default value is '&cv-link-QTDIR;<filename>/bin</filename>'. </para> </listitem> </varlistentry> @@ -5879,9 +5900,9 @@ The default value is '&cv-link-QTDIR;/bin'. <envar>QT_CPPPATH</envar> </term> <listitem><para> -The path where the qt header files are installed. +The path where the Qt header files are installed. The default value is '&cv-link-QTDIR;/include'. -Note: If you set this variable to None, +Note: If you set this variable to <constant>None</constant>, the tool won't change the &cv-link-CPPPATH; construction variable. </para> @@ -5901,8 +5922,10 @@ Prints lots of debugging information while scanning for moc files. <envar>QT_LIB</envar> </term> <listitem><para> -Default value is 'qt'. You may want to set this to 'qt-mt'. Note: If you set -this variable to None, the tool won't change the &cv-link-LIBS; variable. +Default value is <literal>'qt'</literal>. +You may want to set this to <literal>'qt-mt'</literal>. +Note: If you set this variable to <constant>None</constant>, +the tool won't change the &cv-link-LIBS; variable. </para> </listitem> </varlistentry> @@ -5911,9 +5934,9 @@ this variable to None, the tool won't change the &cv-link-LIBS; variable. <envar>QT_LIBPATH</envar> </term> <listitem><para> -The path where the qt libraries are installed. -The default value is '&cv-link-QTDIR;/lib'. -Note: If you set this variable to None, +The path where the Qt libraries are installed. +The default value is '&cv-link-QTDIR;<filename>/lib</filename>'. +Note: If you set this variable to <constant>None</constant>, the tool won't change the &cv-link-LIBPATH; construction variable. </para> @@ -5924,7 +5947,7 @@ construction variable. <envar>QT_MOC</envar> </term> <listitem><para> -Default value is '&cv-link-QT_BINPATH;/moc'. +Default value is '&cv-link-QT_BINPATH;<filename>/moc</filename>'. </para> </listitem> </varlistentry> @@ -5933,7 +5956,8 @@ Default value is '&cv-link-QT_BINPATH;/moc'. <envar>QT_MOCCXXPREFIX</envar> </term> <listitem><para> -Default value is ''. Prefix for moc output files, when source is a cxx file. +Default value is <literal>''</literal>. +Prefix for <command>moc</command> output files when source is a C++ file. </para> </listitem> </varlistentry> @@ -5942,8 +5966,8 @@ Default value is ''. Prefix for moc output files, when source is a cxx file. <envar>QT_MOCCXXSUFFIX</envar> </term> <listitem><para> -Default value is '.moc'. Suffix for moc output files, when source is a cxx -file. +Default value is <literal>'.moc'</literal>. +Suffix for <command>moc</command> output files when source is a C++ file. </para> </listitem> </varlistentry> @@ -5952,7 +5976,7 @@ file. <envar>QT_MOCFROMCXXCOM</envar> </term> <listitem><para> -Command to generate a moc file from a cpp file. +Command to generate a moc file from a C++ file. </para> </listitem> </varlistentry> @@ -5961,7 +5985,7 @@ Command to generate a moc file from a cpp file. <envar>QT_MOCFROMCXXCOMSTR</envar> </term> <listitem><para> -The string displayed when generating a moc file from a cpp file. +The string displayed when generating a moc file from a C++ file. If this is not set, then &cv-link-QT_MOCFROMCXXCOM; (the command line) is displayed. </para> </listitem> @@ -5971,8 +5995,8 @@ If this is not set, then &cv-link-QT_MOCFROMCXXCOM; (the command line) is displa <envar>QT_MOCFROMCXXFLAGS</envar> </term> <listitem><para> -Default value is '-i'. These flags are passed to moc, when moccing a -C++ file. +Default value is <literal>'-i'</literal>. +These flags are passed to <command>moc</command> when moccing a C++ file. </para> </listitem> </varlistentry> @@ -5990,7 +6014,7 @@ Command to generate a moc file from a header. <envar>QT_MOCFROMHCOMSTR</envar> </term> <listitem><para> -The string displayed when generating a moc file from a cpp file. +The string displayed when generating a moc file from a C++ file. If this is not set, then &cv-link-QT_MOCFROMHCOM; (the command line) is displayed. </para> </listitem> @@ -6000,8 +6024,8 @@ If this is not set, then &cv-link-QT_MOCFROMHCOM; (the command line) is displaye <envar>QT_MOCFROMHFLAGS</envar> </term> <listitem><para> -Default value is ''. These flags are passed to moc, when moccing a header -file. +Default value is <literal>''</literal>. These flags are passed to <command>moc</command> +when moccing a header file. </para> </listitem> </varlistentry> @@ -6010,7 +6034,8 @@ file. <envar>QT_MOCHPREFIX</envar> </term> <listitem><para> -Default value is 'moc_'. Prefix for moc output files, when source is a header. +Default value is <literal>'moc_'</literal>. +Prefix for <command>moc</command> output files when source is a header. </para> </listitem> </varlistentry> @@ -6019,8 +6044,8 @@ Default value is 'moc_'. Prefix for moc output files, when source is a header. <envar>QT_MOCHSUFFIX</envar> </term> <listitem><para> -Default value is '&cv-link-CXXFILESUFFIX;'. Suffix for moc output files, when source is -a header. +Default value is '&cv-link-CXXFILESUFFIX;'. +Suffix for moc output files when source is a header. </para> </listitem> </varlistentry> @@ -6029,7 +6054,7 @@ a header. <envar>QT_UIC</envar> </term> <listitem><para> -Default value is '&cv-link-QT_BINPATH;/uic'. +Default value is '&cv-link-QT_BINPATH;<filename>/uic</filename>'. </para> </listitem> </varlistentry> @@ -6038,7 +6063,7 @@ Default value is '&cv-link-QT_BINPATH;/uic'. <envar>QT_UICCOM</envar> </term> <listitem><para> -Command to generate header files from .ui files. +Command to generate header files from <filename>.ui</filename> files. </para> </listitem> </varlistentry> @@ -6047,7 +6072,7 @@ Command to generate header files from .ui files. <envar>QT_UICCOMSTR</envar> </term> <listitem><para> -The string displayed when generating header files from .ui files. +The string displayed when generating header files from <filename>.ui</filename> files. If this is not set, then &cv-link-QT_UICCOM; (the command line) is displayed. </para> </listitem> @@ -6057,8 +6082,8 @@ If this is not set, then &cv-link-QT_UICCOM; (the command line) is displayed. <envar>QT_UICDECLFLAGS</envar> </term> <listitem><para> -Default value is ''. These flags are passed to uic, when creating a a h -file from a .ui file. +Default value is ''. These flags are passed to <command>uic</command> +when creating a header file from a <filename>.ui</filename> file. </para> </listitem> </varlistentry> @@ -6067,7 +6092,8 @@ file from a .ui file. <envar>QT_UICDECLPREFIX</envar> </term> <listitem><para> -Default value is ''. Prefix for uic generated header files. +Default value is <literal>''</literal>. +Prefix for <command>uic</command> generated header files. </para> </listitem> </varlistentry> @@ -6076,7 +6102,8 @@ Default value is ''. Prefix for uic generated header files. <envar>QT_UICDECLSUFFIX</envar> </term> <listitem><para> -Default value is '.h'. Suffix for uic generated header files. +Default value is <literal>'.h'</literal>. +Suffix for <command>uic</command> generated header files. </para> </listitem> </varlistentry> @@ -6085,8 +6112,9 @@ Default value is '.h'. Suffix for uic generated header files. <envar>QT_UICIMPLFLAGS</envar> </term> <listitem><para> -Default value is ''. These flags are passed to uic, when creating a cxx -file from a .ui file. +Default value is <literal>''</literal>. +These flags are passed to <command>uic</command> when creating a C++ +file from a <filename>.ui</filename> file. </para> </listitem> </varlistentry> @@ -6095,7 +6123,8 @@ file from a .ui file. <envar>QT_UICIMPLPREFIX</envar> </term> <listitem><para> -Default value is 'uic_'. Prefix for uic generated implementation files. +Default value is <literal>'uic_'</literal>. +Prefix for uic generated implementation files. </para> </listitem> </varlistentry> @@ -6114,7 +6143,8 @@ files. <envar>QT_UISUFFIX</envar> </term> <listitem><para> -Default value is '.ui'. Suffix of designer input files. +Default value is <literal>'.ui'</literal>. +Suffix of designer input files. </para> </listitem> </varlistentry> @@ -6123,66 +6153,11 @@ Default value is '.ui'. Suffix of designer input files. <envar>QTDIR</envar> </term> <listitem><para> -The qt tool tries to take this from os.environ. -It also initializes all QT_* -construction variables listed below. -(Note that all paths are constructed -with python's os.path.join() method, -but are listed here with the '/' separator -for easier reading.) -In addition, the construction environment -variables &cv-link-CPPPATH;, -&cv-link-LIBPATH; and -&cv-link-LIBS; may be modified -and the variables -&cv-link-PROGEMITTER;, &cv-link-SHLIBEMITTER; and &cv-link-LIBEMITTER; -are modified. Because the build-performance is affected when using this tool, -you have to explicitly specify it at Environment creation: -</para> - -<example_commands> -Environment(tools=['default','qt']) -</example_commands> - -<para> -The qt tool supports the following operations: -</para> - -<para> -<emphasis role="strong">Automatic moc file generation from header files.</emphasis> -You do not have to specify moc files explicitly, the tool does it for you. -However, there are a few preconditions to do so: Your header file must have -the same filebase as your implementation file and must stay in the same -directory. It must have one of the suffixes .h, .hpp, .H, .hxx, .hh. You -can turn off automatic moc file generation by setting QT_AUTOSCAN to 0. -See also the corresponding -&b-Moc;() -builder method. -</para> - -<para> -<emphasis role="strong">Automatic moc file generation from cxx files.</emphasis> -As stated in the qt documentation, include the moc file at the end of -the cxx file. Note that you have to include the file, which is generated -by the transformation ${QT_MOCCXXPREFIX}<basename>${QT_MOCCXXSUFFIX}, by default -<basename>.moc. A warning is generated after building the moc file, if you -do not include the correct file. If you are using VariantDir, you may -need to specify duplicate=1. You can turn off automatic moc file generation -by setting QT_AUTOSCAN to 0. See also the corresponding -&b-Moc; -builder method. -</para> - -<para> -<emphasis role="strong">Automatic handling of .ui files.</emphasis> -The implementation files generated from .ui files are handled much the same -as yacc or lex files. Each .ui file given as a source of Program, Library or -SharedLibrary will generate three files, the declaration file, the -implementation file and a moc file. Because there are also generated headers, -you may need to specify duplicate=1 in calls to VariantDir. -See also the corresponding -&b-Uic; -builder method. +The path to the Qt installation to build against. +If not already set, +&t-link-qt; tool tries to obtain this from +<varname>os.environ</varname>; +if not found there, it tries to make a guess. </para> </listitem> </varlistentry> @@ -7912,75 +7887,64 @@ for more information). <envar>TARGET_ARCH</envar> </term> <listitem><para> - The name of the hardware architecture compiled objects - created by this &consenv; should target. - Can be set when creating a &consenv; by passing as a keyword - argument in the &f-link-Environment; call; should not be - changed otherwise. - If not specified in the &f-Environment; call, will be set to - the defaults for the particular platform, which is in turn - auto-detected unless the <parameter>platform</parameter> - argument to &f-Environment; is given. - Defaults to the same value as &cv-link-HOST_ARCH;. -</para> -<para> - On the Windows platform, if the Microsoft Visual C++ compiler - is available, &t-link-msvc; tool setup is done using - &cv-link-HOST_ARCH; and &cv-TARGET_ARCH;. Changing the values at - any later time will not cause the tool to be reinitialized. - Compiled objects will be in the target architecture if - the compilation system supports generating for that target. - The latest compiler which can fulfill the requirement will - be selected, unless a different version is directed by the - value of the &cv-link-MSVC_VERSION; &consvar;. -</para> -<para> - On the Windows/msvc combination, valid target values are - <literal>x86</literal>, - <literal>arm</literal>, - <literal>i386</literal> - for 32-bit targets and - <literal>amd64</literal>, - <literal>arm64</literal>, - <literal>em64t</literal>, - <literal>x86_64</literal> - and <literal>ia64</literal> (Itanium) - for 64-bit targets. - Note that not all target architectures are - supported for all Visual Studio / MSVC versions. - Check the relevant Microsoft documentation. -</para> -<para> - For example, if you want to compile 64-bit binaries, you would set - <literal>TARGET_ARCH='x86_64'</literal> when creating the &consenv;. -</para> -<para> - On other platforms, this &consvar; is informational and does - not currently affect construction activities. -</para> -</listitem> + The name of the hardware architecture that objects + created using this &consenv; should target. + Can be set when creating a &consenv; by passing as a keyword + argument in the &f-link-Environment; call. + </para> + <para> + On the <literal>win32</literal> platform, + if the Microsoft Visual C++ compiler is available, + &t-link-msvc; tool setup is done using + &cv-link-HOST_ARCH; and &cv-TARGET_ARCH;. + If a value is not specified, + will be set to the same value as &cv-link-HOST_ARCH;. + Changing the value after the environment is initialized + will not cause the tool to be reinitialized. + Compiled objects will be in the target architecture if + the compilation system supports generating for that target. + The latest compiler which can fulfill the requirement will + be selected, unless a different version is directed by the + value of the &cv-link-MSVC_VERSION; &consvar;. + </para> + <para> + On the win32/msvc combination, valid target arch values are + <literal>x86</literal>, + <literal>arm</literal>, + <literal>i386</literal> + for 32-bit targets and + <literal>amd64</literal>, + <literal>arm64</literal>, + <literal>x86_64</literal> + and <literal>ia64</literal> (Itanium) + for 64-bit targets. + For example, if you want to compile 64-bit binaries, you would set + <literal>TARGET_ARCH='x86_64'</literal> when creating the &consenv;. + Note that not all target architectures are + supported for all Visual Studio / MSVC versions. + Check the relevant Microsoft documentation. + </para> + <para> + &cv-TARGET_ARCH; is not currently used by other compilation tools, + but the option is reserved to do so in future + </para> + </listitem> </varlistentry> <varlistentry id="cv-TARGET_OS"> <term> <envar>TARGET_OS</envar> </term> <listitem><para> - The name of the operating system compiled objects - created by this &consenv; should target. - Can be set when creating a &consenv; by passing as a keyword - argument in the &f-link-Environment; call; should not be - changed otherwise. - If not specified in the &f-Environment; call, will be set to - the defaults for the particular platform, which is in turn - auto-detected unless the <parameter>platform</parameter> - argument to &f-Environment; is given. - Defaults to the same value as &cv-HOST_OS;. -</para> -<para> - This &consvar; is informational and does not currently - affect construction activities. -</para> - </listitem> + The name of the operating system that objects + created using this &consenv; should target. + Can be set when creating a &consenv; by passing as a keyword + argument in the &f-link-Environment; call;. + </para> + <para> + &cv-TARGET_OS; is not currently used by &SCons; + but the option is reserved to do so in future + </para> + </listitem> </varlistentry> <varlistentry id="cv-TARGETS"> <term> @@ -8108,7 +8072,7 @@ or <literal>'-via'</literal> for ARM toolchain. <listitem><para> The suffix for the name of the temporary file used to store command lines exceeding &cv-link-MAXLINELENGTH;. -The suffix shouldinclude the dot ('.') if one is wanted as +The suffix should include the dot ('.') if one is wanted as it will not be added automatically. The default is <filename>.lnk</filename>. </para> |