summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2020-04-21 18:17:06 (GMT)
committerWilliam Deegan <bill@baddogconsulting.com>2020-04-21 18:17:06 (GMT)
commitc0e9c494d9dd441627047d462a2c22e8c2beeb9f (patch)
tree13d133cfdcbd13faf7dc91fdb4652b9d8dc7cf52 /src/engine/SCons
parent2cd7a523d39eeba5b29a824766fac71298736bb6 (diff)
downloadSCons-c0e9c494d9dd441627047d462a2c22e8c2beeb9f.zip
SCons-c0e9c494d9dd441627047d462a2c22e8c2beeb9f.tar.gz
SCons-c0e9c494d9dd441627047d462a2c22e8c2beeb9f.tar.bz2
[ci skip] Update docs
Diffstat (limited to 'src/engine/SCons')
-rw-r--r--src/engine/SCons/Tool/msvc.xml18
1 files changed, 14 insertions, 4 deletions
diff --git a/src/engine/SCons/Tool/msvc.xml b/src/engine/SCons/Tool/msvc.xml
index 48ce13f..bdde91b 100644
--- a/src/engine/SCons/Tool/msvc.xml
+++ b/src/engine/SCons/Tool/msvc.xml
@@ -482,7 +482,7 @@ Specify the location of vswhere.exe.
</para>
<para>
-Propose: The <command>vswhere</command> command is distributed with Microsoft Visual Studio and Build
+ The <command>vswhere</command> command is distributed with Microsoft Visual Studio and Build
Tools since the 2017 edition, but is also available standalone. It fully detects 2017 and later editions,
but with the <option>-legacy</option> argument, can detect installations of the 2010 through 2015
editions with limited data returned.
@@ -501,9 +501,19 @@ located.
<para>
Note that &cv-VSWHERE; must be set at the same time or prior to the msvc tool being initialized. So either set it as follows
-<literal>Environment(VSWHERE='c:/my/path/to/vswhere')</literal> or
-if your Environment() is created specifying no tools <literal>tools=[]</literal> or with a list of tools not including msvs or msvc or mslink
- such as <literal>Environment(Tools=[])</literal>
+
+<programlisting>
+env = Environment(VSWHERE='c:/my/path/to/vswhere')
+</programlisting>
+
+or if your Environment() is created specifying no tools
+<literal>tools=[]</literal>
+or with a list of tools not including msvs or msvc or mslink such as
+ <programlisting>
+ env = Environment(Tools=[])
+ env['VSWHERE'] = r'c:/my/vswhere/install/location/vswhere.exe'
+ env.Tool()
+ </programlisting>
</para>