DOC: add doc for TARGET_ARCH/HOST_ARCH + obsolete MSVS_VERSION.

2 files changed, 25 insertions, 0 deletions

diff --git a/src/engine/SCons/Tool/msvc.xml b/src/engine/SCons/Tool/msvc.xml
index 700e76d..17cec19 100644
--- a/src/engine/SCons/Tool/msvc.xml
+++ b/src/engine/SCons/Tool/msvc.xml
@@ -286,3 +286,24 @@ If the specified version isn't installed,
 tool initialization will fail.
 </summary>
 </cvar>
+
+<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.
+
+Valid values are the same as for &cv-TARGET_ARCH;.
+
+</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.
+</summary>
+</cvar>
diff --git a/src/engine/SCons/Tool/msvs.xml b/src/engine/SCons/Tool/msvs.xml
index 33db424..363881a 100644
--- a/src/engine/SCons/Tool/msvs.xml
+++ b/src/engine/SCons/Tool/msvs.xml
@@ -505,6 +505,10 @@ variable in the Environment initialization, setting it to the
 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.
 </summary>
 </cvar>