From: garyo <garyo@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Date: Tue, 24 Nov 2009 03:13:13 +0000 (+0000)
Subject: Doc tweaks for MSVC_VERSION and TARGET_ARCH.
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=36785ca16d67b718b1b238341ccc75e490790fed;p=scons.git

Doc tweaks for MSVC_VERSION and TARGET_ARCH.

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

diff --git a/src/engine/SCons/Tool/msvc.xml b/src/engine/SCons/Tool/msvc.xml
index 17cec199..e62a845a 100644
--- a/src/engine/SCons/Tool/msvc.xml
+++ b/src/engine/SCons/Tool/msvc.xml
@@ -289,21 +289,28 @@ tool initialization will fail.
 
 <cvar name="HOST_ARCH">
 <summary>
-Sets the host arch for Visual Studio compiler. If not set, default to the
-detected host architecture: note that this may depend on the python you are
-using.
+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.
 
 Valid values are the same as for &cv-TARGET_ARCH;.
 
+This is currently only used on Windows, but in the future it will be
+used on other OSes as well.
 </summary>
 </cvar>
 <cvar name="TARGET_ARCH">
 <summary>
-Sets the target arch for Visual Studio compiler (i.e. the arch of the binaries
-generated by the compiler). If not set, default to &cv-HOST_ARCH;.
-
-Valid values are 'x86', 'i386' (for 32 bits), 'amd64', 'emt64', 'x86_64' (64
-bits) and 'ia64' (Itanium). For example, if you want to compile 64 bits
-binaries, you would set TARGET_ARCH='x86_64' in your environment.
+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;.  
+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).
+For example, if you want to compile 64-bit binaries, you would set
+TARGET_ARCH='x86_64' in your SCons environment.
 </summary>
 </cvar>
diff --git a/src/engine/SCons/Tool/msvs.xml b/src/engine/SCons/Tool/msvs.xml
index 363881a3..7fe08013 100644
--- a/src/engine/SCons/Tool/msvs.xml
+++ b/src/engine/SCons/Tool/msvs.xml
@@ -506,9 +506,9 @@ appropriate version ('6.0' or '7.0', for example).
 If the specified version isn't installed,
 tool initialization will fail.
 
-This is obsolete: use &cv-MSVC_VERSION; instead. If &cv-MSVS_VERSION; and not
-&cv-MSVC_VERSION; is set, &cv-MSVC_VERSION; will be set to &cv-MSVS_VERSION;.
-If both are set to a different value, scons will raise an error.
+This is obsolete: use &cv-MSVC_VERSION; instead. If &cv-MSVS_VERSION; is set and
+&cv-MSVC_VERSION; is not, &cv-MSVC_VERSION; will be set automatically to &cv-MSVS_VERSION;.
+If both are set to different values, scons will raise an error.
 </summary>
 </cvar>