diff options
Diffstat (limited to 'src/engine/SCons/Subst.xml')
| -rw-r--r-- | src/engine/SCons/Subst.xml | 33 |
1 files changed, 30 insertions, 3 deletions
diff --git a/src/engine/SCons/Subst.xml b/src/engine/SCons/Subst.xml index bc2daa3..26abf10 100644 --- a/src/engine/SCons/Subst.xml +++ b/src/engine/SCons/Subst.xml @@ -1,15 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> <!-- -Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation +Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation This file is processed by the bin/SConsDoc.py module. See its __doc__ string for a discussion of the format. --> +<!DOCTYPE sconsdoc [ +<!ENTITY % scons SYSTEM '../../../doc/scons.mod'> +%scons; +<!ENTITY % builders-mod SYSTEM '../../../doc/generated/builders.mod'> +%builders-mod; +<!ENTITY % functions-mod SYSTEM '../../../doc/generated/functions.mod'> +%functions-mod; +<!ENTITY % tools-mod SYSTEM '../../../doc/generated/tools.mod'> +%tools-mod; +<!ENTITY % variables-mod SYSTEM '../../../doc/generated/variables.mod'> +%variables-mod; +]> + +<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd"> + + <scons_function name="AllowSubstExceptions"> <arguments signature="global"> ([exception, ...]) </arguments> <summary> +<para> Specifies the exceptions that will be allowed when expanding construction variables. By default, @@ -23,16 +43,21 @@ exception will expand to a All exceptions not in the specified list will generate an error message and terminate processing. +</para> +<para> If &f-AllowSubstExceptions; is called multiple times, each call completely overwrites the previous list of allowed exceptions. +</para> +<para> Example: +</para> -<example> +<example_commands> # Requires that all construction variable names exist. # (You may wish to do this if you want to enforce strictly # that all construction variables must be defined before use.) @@ -41,6 +66,8 @@ AllowSubstExceptions() # Also allow a string containing a zero-division expansion # like '${1 / 0}' to evalute to ''. AllowSubstExceptions(IndexError, NameError, ZeroDivisionError) -</example> +</example_commands> </summary> </scons_function> + +</sconsdoc>
\ No newline at end of file |