diff options
| -rw-r--r-- | SCons/Tool/swig.xml | 77 | ||||
| -rw-r--r-- | doc/scons.mod | 2 |
2 files changed, 35 insertions, 44 deletions
diff --git a/SCons/Tool/swig.xml b/SCons/Tool/swig.xml index 19ec21f..0e3e5c0 100644 --- a/SCons/Tool/swig.xml +++ b/SCons/Tool/swig.xml @@ -26,7 +26,7 @@ See its __doc__ string for a discussion of the format. <tool name="swig"> <summary> <para> -Sets construction variables for the SWIG interface generator. +Sets construction variables for the &swig; interface compiler. </para> </summary> <sets> @@ -50,7 +50,7 @@ Sets construction variables for the SWIG interface generator. <cvar name="SWIG"> <summary> <para> -The scripting language wrapper and interface generator. +The name of the &swig; compiler to use. </para> </summary> </cvar> @@ -59,10 +59,11 @@ The scripting language wrapper and interface generator. <summary> <para> The suffix that will be used for intermediate C -source files generated by -the scripting language wrapper and interface generator. -The default value is -<filename>_wrap</filename>&cv-link-CFILESUFFIX;. +source files generated by &swig;. +The default value is <literal>'_wrap$CFILESUFFIX'</literal> - +that is, the concatenation of the string +<literal>_wrap</literal> +and the platform's C suffix &cv-link-CFILESUFFIX;. By default, this value is used whenever the <option>-c++</option> option is @@ -78,8 +79,8 @@ construction variable. <summary> <para> The suffix that will be used for intermediate C++ header -files generated by the scripting language wrapper and interface generator. -These are only generated for C++ code when the SWIG 'directors' feature is +files generated by &swig;. +These are only generated for C++ code when the &swig; 'directors' feature is turned on. The default value is <filename>_wrap.h</filename>. @@ -90,8 +91,7 @@ The default value is <cvar name="SWIGCOM"> <summary> <para> -The command line used to call -the scripting language wrapper and interface generator. +The command line used to call &swig;. </para> </summary> </cvar> @@ -99,8 +99,7 @@ the scripting language wrapper and interface generator. <cvar name="SWIGCOMSTR"> <summary> <para> -The string displayed when calling -the scripting language wrapper and interface generator. +The string displayed when calling &swig;. If this is not set, then &cv-link-SWIGCOM; (the command line) is displayed. </para> </summary> @@ -110,10 +109,11 @@ If this is not set, then &cv-link-SWIGCOM; (the command line) is displayed. <summary> <para> The suffix that will be used for intermediate C++ -source files generated by -the scripting language wrapper and interface generator. -The default value is -<filename>_wrap</filename>&cv-link-CFILESUFFIX;. +source files generated by &swig;. +The default value is <literal>'_wrap$CXXFILESUFFIX'</literal> - +that is, the concatenation of the string +<literal>_wrap</literal> +and the platform's C++ suffix &cv-link-CXXFILESUFFIX;. By default, this value is used whenever the <filename>-c++</filename> option is specified as part of the @@ -126,22 +126,12 @@ construction variable. <cvar name="SWIGFLAGS"> <summary> <para> -General options passed to -the scripting language wrapper and interface generator. -This is where you should set -<option>-python</option>, +General options passed to &swig;. +This is where you should set the target language +(<option>-python</option>, <option>-perl5</option>, -<option>-tcl</option>, -or whatever other options you want to specify to SWIG. -If you set the -<option>-c++</option> -option in this variable, -&scons; -will, by default, -generate a C++ intermediate source file -with the extension that is specified as the -&cv-link-CXXFILESUFFIX; -variable. +<option>-tcl</option>, etc.) +and whatever other options you want to specify to &swig;. </para> </summary> </cvar> @@ -150,7 +140,7 @@ variable. <summary> <para> An automatically-generated construction variable -containing the SWIG command-line options +containing the &swig; command-line options for specifying directories to be searched for included files. The value of &cv-_SWIGINCFLAGS; is created by respectively prepending and appending @@ -164,7 +154,7 @@ of each directory in &cv-SWIGPATH;. <cvar name="SWIGINCPREFIX"> <summary> <para> -The prefix used to specify an include directory on the SWIG command line. +The prefix used to specify an include directory on the &swig; command line. This will be prepended to the beginning of each directory in the &cv-SWIGPATH; construction variable when the &cv-_SWIGINCFLAGS; variable is automatically generated. @@ -175,7 +165,7 @@ when the &cv-_SWIGINCFLAGS; variable is automatically generated. <cvar name="SWIGINCSUFFIX"> <summary> <para> -The suffix used to specify an include directory on the SWIG command line. +The suffix used to specify an include directory on the &swig; command line. This will be appended to the end of each directory in the &cv-SWIGPATH; construction variable when the &cv-_SWIGINCFLAGS; variable is automatically generated. @@ -186,8 +176,7 @@ when the &cv-_SWIGINCFLAGS; variable is automatically generated. <cvar name="SWIGOUTDIR"> <summary> <para> -Specifies the output directory in which -the scripting language wrapper and interface generator +Specifies the output directory in which &swig; should place generated language-specific files. This will be used by SCons to identify the files that will be generated by the &swig; call, @@ -200,22 +189,24 @@ and translated into the <cvar name="SWIGPATH"> <summary> <para> -The list of directories that the scripting language wrapper -and interface generate will search for included files. -The SWIG implicit dependency scanner will search these +The list of directories that &swig; +will search for included files. +&SCons;' SWIG implicit dependency scanner will search these directories for include files. The default value is an empty list. </para> <para> Don't explicitly put include directory -arguments in SWIGFLAGS; +arguments in &cv-link-SWIGFLAGS; the result will be non-portable and the directories will not be searched by the dependency scanner. -Note: directory names in SWIGPATH will be looked-up relative to the SConscript +Note: directory names in &cv-link-SWIGPATH; +will be looked-up relative to the SConscript directory when they are used in a command. To force &scons; -to look-up a directory relative to the root of the source tree use #: +to look-up a directory relative to the root of the source tree use +a top-relative path (<literal>#</literal>): </para> <example_commands> @@ -258,7 +249,7 @@ env = Environment(SWIGCOM="my_swig -o $TARGET $_SWIGINCFLAGS $SOURCES") <cvar name="SWIGVERSION"> <summary> <para> -The version number of the SWIG tool. +The detected version string of the &swig; tool. </para> </summary> </cvar> diff --git a/doc/scons.mod b/doc/scons.mod index 8a6df17..4c5dc14 100644 --- a/doc/scons.mod +++ b/doc/scons.mod @@ -84,7 +84,7 @@ <!ENTITY rmic "<application xmlns='http://www.scons.org/dbxsd/v1.0'>rmic</application>"> <!ENTITY ScCons "<application xmlns='http://www.scons.org/dbxsd/v1.0'>ScCons</application>"> <!ENTITY sleep "<application xmlns='http://www.scons.org/dbxsd/v1.0'>sleep</application>"> -<!ENTITY swig "<application xmlns='http://www.scons.org/dbxsd/v1.0'>swig</application>"> +<!ENTITY swig "<application xmlns='http://www.scons.org/dbxsd/v1.0'>SWIG</application>"> <!ENTITY tar "<application xmlns='http://www.scons.org/dbxsd/v1.0'>tar</application>"> <!ENTITY tex "<application xmlns='http://www.scons.org/dbxsd/v1.0'>tex</application>"> <!ENTITY touch "<application xmlns='http://www.scons.org/dbxsd/v1.0'>touch</application>"> |