summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2020-07-04 13:30:10 -0700
committerWilliam Deegan <bill@baddogconsulting.com>2020-07-04 13:30:10 -0700
commitfffb1335bc7600733a71a48de5162fe1f6d9df7d (patch)
tree8f77a1ae9f35449324f667f8fe489d7a233808c9
parent02086028b38a627ffbb42316af0bda70f2d5be72 (diff)
downloadscons-git-fffb1335bc7600733a71a48de5162fe1f6d9df7d.tar.gz
Updated generated doc files for 4.0.0
-rw-r--r--doc/generated/examples/caching_ex-random_1.xml6
-rw-r--r--doc/generated/examples/troubleshoot_explain1_3.xml2
-rw-r--r--doc/generated/variables.gen66
3 files changed, 47 insertions, 27 deletions
diff --git a/doc/generated/examples/caching_ex-random_1.xml b/doc/generated/examples/caching_ex-random_1.xml
index cd09c1007..eb083df25 100644
--- a/doc/generated/examples/caching_ex-random_1.xml
+++ b/doc/generated/examples/caching_ex-random_1.xml
@@ -1,8 +1,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 f3.o -c f3.c
-cc -o f1.o -c f1.c
-cc -o f5.o -c f5.c
cc -o f2.o -c f2.c
+cc -o f5.o -c f5.c
cc -o f4.o -c f4.c
+cc -o f1.o -c f1.c
+cc -o f3.o -c f3.c
cc -o prog f1.o f2.o f3.o f4.o f5.o
</screen>
diff --git a/doc/generated/examples/troubleshoot_explain1_3.xml b/doc/generated/examples/troubleshoot_explain1_3.xml
index 4e53d5e67..6b90e1cab 100644
--- a/doc/generated/examples/troubleshoot_explain1_3.xml
+++ b/doc/generated/examples/troubleshoot_explain1_3.xml
@@ -2,5 +2,5 @@
cp file.in file.oout
scons: warning: Cannot find target file.out after building
-File "/Users/bdbaddog/devel/scons/git/scons-bugfixes-2/scripts/scons.py", line 96, in &lt;module&gt;
+File "/Users/bdbaddog/devel/scons/git/as_scons/scripts/scons.py", line 96, in &lt;module&gt;
</screen>
diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen
index e100939bc..5d1260fb3 100644
--- a/doc/generated/variables.gen
+++ b/doc/generated/variables.gen
@@ -3050,15 +3050,15 @@ Sets the host architecture for Visual Studio compiler. If not set,
default to the detected host architecture: note that this may depend
on the python you are using.
This variable must be passed as an argument to the Environment()
-constructor; setting it later has no effect.
+constructor; setting it later has no effect.
</para>
<para>
-Valid values are the same as for &cv-TARGET_ARCH;.
+Valid values are the same as for &cv-link-TARGET_ARCH;.
</para>
<para>
-This is currently only used on Windows, but in the future it will be
+This is currently only used on Windows, but in the future it may be
used on other OSes as well.
</para>
</listitem>
@@ -4589,17 +4589,32 @@ will be compiled separately.
<envar>MSVC_USE_SCRIPT</envar>
</term>
<listitem><para>
-Use a batch script to set up Microsoft Visual Studio compiler
+Use a batch script to set up Microsoft Visual Studio compiler.
+</para>
+
+<para>
+If set to the name of a Visual Studio <filename>.bat</filename> file
+(e.g. <filename>vcvars.bat</filename>),
+&SCons; will run that batch file instead of the auto-detected one,
+and extract the relevant variables from the result (typically
+<envar>%INCLUDE%</envar>,
+<envar>%LIB%</envar>, and
+<envar>%PATH%</envar>) for supplying to the build.
+This can be useful to force the use of a compiler version that
+&SCons; does not detect.
</para>
<para>
-&cv-MSVC_USE_SCRIPT; overrides &cv-MSVC_VERSION; and &cv-TARGET_ARCH;.
-If set to the name of a Visual Studio .bat file (e.g. vcvars.bat),
-SCons will run that bat file and extract the relevant variables from
-the result (typically %INCLUDE%, %LIB%, and %PATH%). Setting
-MSVC_USE_SCRIPT to None bypasses the Visual Studio autodetection
-entirely; use this if you are running SCons in a Visual Studio cmd
-window and importing the shell's environment variables.
+Setting
+&cv-MSVC_USE_SCRIPT; to <constant>None</constant> bypasses the
+Visual Studio autodetection entirely;
+use this if you are running SCons in a Visual Studio cmd
+window and importing the shell's environment variables - that
+is, if you are sure everything is set correctly already and
+you don't want &SCons; to change anything.
+</para>
+<para>
+&cv-MSVC_USE_SCRIPT; overrides &cv-link-MSVC_VERSION; and &cv-link-TARGET_ARCH;.
</para>
</listitem>
</varlistentry>
@@ -4616,7 +4631,7 @@ If &cv-MSVC_UWP_APP; is set, the Visual Studio environment will be set up to poi
to the Windows Store compatible libraries and Visual Studio runtimes. In doing so,
any libraries that are built will be able to be used in a UWP App and published
to the Windows Store.
-This flag will only have an effect with Visual Studio 2015+.
+This flag will only have an effect with Visual Studio 2015 or later.
This variable must be passed as an argument to the Environment()
constructor; setting it later has no effect.
</para>
@@ -4663,7 +4678,7 @@ Valid values for Windows are
<literal>7.1</literal>,
<literal>7.0</literal>,
and <literal>6.0</literal>.
-Versions ending in <literal>Exp</literal> refer to "Express" or
+Versions ending in <literal>Exp</literal> refer to "Express" or
"Express for Desktop" editions.
</para>
@@ -7659,31 +7674,36 @@ for more information).
<para>
Sets the target architecture for Visual Studio compiler (i.e. the arch
of the binaries generated by the compiler). If not set, default to
-&cv-HOST_ARCH;, or, if that is unset, to the architecture of the
+&cv-link-HOST_ARCH;, or, if that is unset, to the architecture of the
running machine's OS (note that the python build or architecture has no
effect).
This variable must be passed as an argument to the Environment()
-constructor; setting it later has no effect.
+constructor; setting it later has no effect.
This is currently only used on Windows, but in the future it will be
used on other OSes as well.
-If this is set and MSVC_VERSION is not set, this will search for
-all installed MSVC's that support the TARGET_ARCH, selecting the
+If this is set and &cv-link-MSVC_VERSION; is not set, this will search for
+all installed MSVC's that support the &cv-TARGET_ARCH;, selecting the
latest version for use.
</para>
<para>
-Valid values for Windows are
+On Windows, valid target values are
<literal>x86</literal>,
<literal>arm</literal>,
<literal>i386</literal>
-(for 32 bits);
+for 32-bit targets and
<literal>amd64</literal>,
<literal>arm64</literal>,
-<literal>emt64</literal>,
+<literal>em64t</literal>,
<literal>x86_64</literal>
-(for 64 bits);
-and <literal>ia64</literal> (Itanium).
+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> in your SCons environment.
</para>
@@ -7901,7 +7921,7 @@ The version of the project, specified as a string.
<envar>VSWHERE</envar>
</term>
<listitem><para>
-Specify the location of <filename>vswhere.exe</filename>.
+Specify the location of <filename>vswhere.exe</filename>.
</para>
<para>