SCons/Tool/mssdk.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
   4 SPDX-License-Identifier: MIT
   5 SPDX-FileType: DOCUMENTATION
   6
   7 This file is processed by the bin/SConsDoc.py module.
   8 -->
   9
  10 <!DOCTYPE sconsdoc [
  11 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  12 %scons;
  13 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  14 %builders-mod;
  15 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  16 %functions-mod;
  17 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  18 %tools-mod;
  19 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  20 %variables-mod;
  21 ]>
  22
  23 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  24           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  25           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  26
  27 <tool name="mssdk">
  28 <summary>
  29 <para>
  30 Sets variables for Microsoft Platform SDK and/or Windows SDK.
  31 Note that unlike most other Tool modules,
  32 mssdk does not set construction variables,
  33 but sets the <emphasis>environment variables</emphasis>
  34 in the environment &SCons; uses to execute
  35 the Microsoft toolchain:
  36 <literal>%INCLUDE%</literal>,
  37 <literal>%LIB%</literal>,
  38 <literal>%LIBPATH%</literal> and
  39 <literal>%PATH%</literal>.
  40 </para>
  41 </summary>
  42 <sets>
  43 </sets>
  44 <uses>
  45 <item>MSSDK_DIR</item>
  46 <item>MSSDK_VERSION</item>
  47 <item>MSVS_VERSION</item>
  48 </uses>
  49 </tool>
  50
  51 <cvar name="MSSDK_DIR">
  52 <summary>
  53 <para>
  54 The directory containing the Microsoft SDK
  55 (either Platform SDK or Windows SDK)
  56 to be used for compilation.
  57 </para>
  58 </summary>
  59 </cvar>
  60
  61 <cvar name="MSSDK_VERSION">
  62 <summary>
  63 <para>
  64 The version string of the Microsoft SDK
  65 (either Platform SDK or Windows SDK)
  66 to be used for compilation.
  67 Supported versions include
  68 <literal>6.1</literal>,
  69 <literal>6.0A</literal>,
  70 <literal>6.0</literal>,
  71 <literal>2003R2</literal>
  72 and
  73 <literal>2003R1</literal>.
  74 </para>
  75 </summary>
  76 </cvar>
  77
  78 </sconsdoc>