summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/msvc.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/msvc.xml')
-rw-r--r--src/engine/SCons/Tool/msvc.xml28
1 files changed, 24 insertions, 4 deletions
diff --git a/src/engine/SCons/Tool/msvc.xml b/src/engine/SCons/Tool/msvc.xml
index 556036d..9456730 100644
--- a/src/engine/SCons/Tool/msvc.xml
+++ b/src/engine/SCons/Tool/msvc.xml
@@ -288,6 +288,20 @@ value (e.g. "XXX") to see the valid values on your system.
</summary>
</cvar>
+<cvar name="MSVC_USE_SCRIPT">
+<summary>
+Use a batch script to set up Microsoft Visual Studio compiler
+
+&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.
+</summary>
+</cvar>
+
<cvar name="HOST_ARCH">
<summary>
Sets the host architecture for Visual Studio compiler. If not set,
@@ -314,10 +328,16 @@ 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.
-Valid values for Windows are 'x86', 'i386' (for 32 bits);
-'amd64', 'emt64', 'x86_64' (64 bits);
-and 'ia64' (Itanium).
+Valid values for Windows are
+<literal>x86</literal>,
+<literal>i386</literal>
+(for 32 bits);
+<literal>amd64</literal>,
+<literal>emt64</literal>,
+<literal>x86_64</literal>
+(for 64 bits);
+and <literal>ia64</literal> (Itanium).
For example, if you want to compile 64-bit binaries, you would set
-TARGET_ARCH='x86_64' in your SCons environment.
+<literal>TARGET_ARCH='x86_64'</literal> in your SCons environment.
</summary>
</cvar>