diff options
Diffstat (limited to 'SCons/Tool/msvc.xml')
-rw-r--r-- | SCons/Tool/msvc.xml | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/SCons/Tool/msvc.xml b/SCons/Tool/msvc.xml index 4a45d26..e8df128 100644 --- a/SCons/Tool/msvc.xml +++ b/SCons/Tool/msvc.xml @@ -74,6 +74,7 @@ Sets construction variables for the Microsoft Visual C/C++ compiler. <item>PCH</item> <item>PCHSTOP</item> <item>PDB</item> +<item>MSVC_NOTFOUND_POLICY</item> </uses> </tool> @@ -578,5 +579,98 @@ and also before &f-link-env-Tool; is called to ininitialize any of those tools: </summary> </cvar> +<cvar name="MSVC_NOTFOUND_POLICY"> +<summary> +<para> +Specify the scons behavior when the Microsoft Visual C/C++ compiler is not detected. +</para> + +<para> + The <envar>MSVC_NOTFOUND_POLICY</envar> specifies the &scons; behavior when no msvc versions are detected or + when the requested msvc version is not detected. +</para> + +<para> +The valid values for <envar>MSVC_NOTFOUND_POLICY</envar> and the corresponding &scons; behavior are: +</para> + +<variablelist> + +<varlistentry> +<term><parameter>'Error' or 'Exception'</parameter></term> +<listitem> +<para> +Raise an exception when no msvc versions are detected or when the requested msvc version is not detected. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><parameter>'Warning' or 'Warn'</parameter></term> +<listitem> +<para> +Issue a warning and continue when no msvc versions are detected or when the requested msvc version is not detected. +Depending on usage, this could result in build failure(s). +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><parameter>'Ignore' or 'Suppress'</parameter></term> +<listitem> +<para> +Take no action and continue when no msvc versions are detected or when the requested msvc version is not detected. +Depending on usage, this could result in build failure(s). +</para> +</listitem> +</varlistentry> + +</variablelist> + +<para> +Note: in addition to the camel case values shown above, lower case and upper case values are accepted as well. +</para> + +<para> +The <envar>MSVC_NOTFOUND_POLICY</envar> is applied when any of the following conditions are satisfied: +<itemizedlist> +<listitem><para> +&cv-MSVC_VERSION; is specified, the default tools list is implicitly defined (i.e., the tools list is not specified), +and the default tools list contains one or more of the msvc tools. +</para></listitem> +<listitem><para> +&cv-MSVC_VERSION; is specified, the default tools list is explicitly specified (e.g., <literal>tools=['default']</literal>), +and the default tools list contains one or more of the msvc tools. +</para></listitem> +<listitem><para> +A non-default tools list is specified that contains one or more of the msvc tools (e.g., <literal>tools=['msvc', 'mslink']</literal>). +</para></listitem> +</itemizedlist> +</para> + +<para> +The <envar>MSVC_NOTFOUND_POLICY</envar> is ignored when any of the following conditions are satisfied: +<itemizedlist> +<listitem><para> +&cv-MSVC_VERSION; is not specified and the default tools list is implicitly defined (i.e., the tools list is not specified). +</para></listitem> +<listitem><para> +&cv-MSVC_VERSION; is not specified and the default tools list is explicitly specified (e.g., <literal>tools=['default']</literal>). +</para></listitem> +<listitem><para> +A non-default tool list is specified that does not contain any of the msvc tools (e.g., <literal>tools=['mingw']</literal>). +</para></listitem> +</itemizedlist> +</para> + +<para> +When <envar>MSVC_NOTFOUND_POLICY</envar> is not specified, the default &scons; behavior is to issue a warning and continue +subject to the conditions listed above. The default &scons; behavior may change in the future. +</para> + + +</summary> +</cvar> + </sconsdoc> |