Add documentation for MSVC_USE_SCRIPT.

git-svn-id: http://scons.tigris.org/svn/scons/trunk@4672 fdb21ef1-2011-0410-befe-b5e4ea1792b1

diff --git a/src/RELEASE.txt b/src/RELEASE.txt
index 80129e88787cede74bab738ca34c6dd78f89620a..8e462e623d3797b197a9df24d62ded4b398da1b4 100644 (file)
--- a/src/RELEASE.txt
+++ b/src/RELEASE.txt
@@ -76,6 +76,15 @@ RELEASE 1.2.0.d20100117 - Sun, 17 Jan 2010 14:26:59 -0800
        set TARGET_ARCH to "x86" or "x86_64" (various synonyms are
        accepted).
 
+       In addition, MSVC_USE_SCRIPT can be used to bypass the 
+       above autodetection; setting it to the path of a Visual
+       Studio .bat file (e.g. vcvars.bat) will cause SCons to
+       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 importing
+       the shell env and running SCons in a Visual Studio cmd window.
+
        Note that if you use MSVS_VERSION to build Visual Studio
        projects from your SConstructs, MSVS_VERSION must be set to
        the same version as MSVC_VERSION.

diff --git a/src/engine/SCons/Tool/msvc.xml b/src/engine/SCons/Tool/msvc.xml
index f4be77059e87f43f2c95fd37a82c2a607412b4e3..c2fed869057d6f33394eb193684621326916df83 100644 (file)
--- 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,