diff options
Diffstat (limited to 'SCons')
| -rw-r--r-- | SCons/Defaults.xml | 14 | ||||
| -rw-r--r-- | SCons/Tool/compilation_db.xml | 2 | ||||
| -rw-r--r-- | SCons/Tool/default.xml | 66 | ||||
| -rw-r--r-- | SCons/Tool/docbook/docbook.xml | 100 | ||||
| -rw-r--r-- | SCons/Tool/dvi.xml | 2 | ||||
| -rw-r--r-- | SCons/Tool/gas.xml | 2 | ||||
| -rw-r--r-- | SCons/Tool/gettext.xml | 4 | ||||
| -rw-r--r-- | SCons/Tool/gs.xml | 27 | ||||
| -rw-r--r-- | SCons/Tool/hpcc.xml | 6 | ||||
| -rw-r--r-- | SCons/Tool/intelc.xml | 6 | ||||
| -rw-r--r-- | SCons/Tool/link.xml | 20 | ||||
| -rw-r--r-- | SCons/Tool/packaging/packaging.xml | 2 |
12 files changed, 145 insertions, 106 deletions
diff --git a/SCons/Defaults.xml b/SCons/Defaults.xml index a6c1ec3..33d219b 100644 --- a/SCons/Defaults.xml +++ b/SCons/Defaults.xml @@ -26,7 +26,7 @@ See its __doc__ string for a discussion of the format. <cvar name ="_concat"> <summary> <para> -A function used to produce variables like &cv-_CPPINCFLAGS;. It takes +A function used to produce variables like &cv-link-_CPPINCFLAGS;. It takes four or five arguments: a prefix to concatenate onto each element, a list of elements, a suffix to concatenate onto each element, an environment @@ -58,7 +58,7 @@ file. <cvar name="CONFIGURELOG"> <summary> <para> -The name of the Configure context log file. +The name of the &Configure; context log file. The default is <filename>config.log</filename> in the top-level directory @@ -75,7 +75,7 @@ file. An automatically-generated &consvar; containing the C preprocessor command-line options to define values. -The value of &cv-_CPPDEFFLAGS; is created +The value of &cv-link-_CPPDEFFLAGS; is created by respectively prepending and appending &cv-link-CPPDEFPREFIX; and &cv-link-CPPDEFSUFFIX; to each definition in &cv-link-CPPDEFINES;. @@ -99,7 +99,7 @@ If &cv-CPPDEFINES; is a string, the values of the &cv-link-CPPDEFPREFIX; and &cv-link-CPPDEFSUFFIX; &consvars; will be respectively prepended and appended to -each definition in &cv-CPPDEFINES;. +each definition in &cv-link-CPPDEFINES;. </para> <example_commands> @@ -111,7 +111,7 @@ env = Environment(CPPDEFINES='xyz') <para> If &cv-CPPDEFINES; is a list, the values of the -&cv-link-CPPDEFPREFIX; and &cv-link-CPPDEFSUFFIX; &consvars; +&cv-CPPDEFPREFIX; and &cv-CPPDEFSUFFIX; &consvars; will be respectively prepended and appended to each element in the list. If any element is a list or tuple, @@ -128,7 +128,7 @@ env = Environment(CPPDEFINES=[('B', 2), 'A']) <para> If &cv-CPPDEFINES; is a dictionary, the values of the -&cv-link-CPPDEFPREFIX; and &cv-link-CPPDEFSUFFIX; &consvars; +&cv-CPPDEFPREFIX; and &cv-CPPDEFSUFFIX; &consvars; will be respectively prepended and appended to each item from the dictionary. The key of each dictionary item @@ -207,7 +207,7 @@ Python's <systemitem>os.sep</systemitem>. <para> Note: -directory names in &cv-link-CPPPATH; +directory names in &cv-CPPPATH; will be looked-up relative to the directory of the SConscript file when they are used in a command. To force &scons; diff --git a/SCons/Tool/compilation_db.xml b/SCons/Tool/compilation_db.xml index aac1ed2..bad808f 100644 --- a/SCons/Tool/compilation_db.xml +++ b/SCons/Tool/compilation_db.xml @@ -103,7 +103,7 @@ See its __doc__ string for a discussion of the format. <cvar name="COMPILATIONDB_COMSTR"> <summary> <para> - The string displayed when the &b-CompilationDatabase; + The string displayed when the &b-link-CompilationDatabase; builder's action is run. </para> </summary> diff --git a/SCons/Tool/default.xml b/SCons/Tool/default.xml index c729c1c..15dc2f7 100644 --- a/SCons/Tool/default.xml +++ b/SCons/Tool/default.xml @@ -41,67 +41,79 @@ the platform and on the software installed on the platform. Some tools will not initialize if an underlying command is not found, and some tools are selected from a list of choices on a first-found basis. The finished tool list can be -examined by inspecting the <envar>TOOLS</envar> &consvar; +examined by inspecting the &cv-link-TOOLS; &consvar; in the &consenv;. </para> <para> -On all platforms, all tools from the following list -are selected whose respective conditions are met: -filesystem, wix, lex, yacc, rpcgen, swig, -jar, javac, javah, rmic, dvipdf, dvips, gs, -tex, latex, pdflatex, pdftex, tar, zip, textfile. +On all platforms, the tools from the following list +are selected if their respective conditions are met: +<!--TODO: &t-link-filesystem; --> filesystem;, +<!--TODO &t-link-wix; --> wix, +&t-link-lex;, &t-link-yacc;, +&t-link-rpcgen;, &t-link-swig;, +&t-link-jar;, &t-link-javac;, &t-link-javah;, &t-link-rmic;, +&t-link-dvipdf;, &t-link-dvips;, &t-link-gs;, +&t-link-tex;, &t-link-latex;, &t-link-pdflatex;, &t-link-pdftex;, +&t-link-tar;, &t-link-zip;, &t-link-textfile;. </para> <para> On Linux systems, the default tools list selects (first-found): a C compiler from -gcc, intelc, icc, cc; +&t-link-gcc;, &t-link-intelc;, &t-link-icc;, &t-link-cc;; a C++ compiler from -g++, intelc, icc, cxx; +&t-link-gXX;, &t-link-intelc;, &t-link-icc;, &t-link-cXX;; an assembler from -gas, nasm, masm; +&t-link-gas;, &t-link-nasm;, &t-link-masm;; a linker from -gnulink, ilink; +&t-link-gnulink;, &t-link-ilink;; a Fortran compiler from -gfortran, g77, ifort, ifl, f95, f90, f77; -and a static archiver 'ar'. +&t-link-gfortran;, &t-link-g77;, &t-link-ifort;, &t-link-ifl;, +&t-link-f95;, &t-link-f90;, &t-link-f77;; +and a static archiver &t-link-ar;. It also selects all found from the list -m4, rpm. +&t-link-m4; +<!-- TODO &t-link-rpm; --> rpm. </para> <para> On Windows systems, the default tools list selects (first-found): a C compiler from -msvc, mingw, gcc, intelc, icl, icc, cc, bcc32; +&t-link-msvc;, &t-link-mingw;, &t-link-gcc;, &t-link-intelc;, +&t-link-icl;, &t-link-icc;, &t-link-cc;, &t-link-bcc32;; a C++ compiler from -msvc, intelc, icc, g++, cxx, bcc32; +&t-link-msvc;, &t-link-intelc;, &t-link-icc;, &t-link-gXX;, +&t-link-cXX;, &t-link-bcc32;; an assembler from -masm, nasm, gas, 386asm; +&t-link-masm;, &t-link-nasm;, &t-link-gas;, &t-link-386asm;; a linker from -mslink, gnulink, ilink, linkloc, ilink32; +&t-link-mslink;, &t-link-gnulink;, &t-link-ilink;, +&t-link-linkloc;, &t-link-ilink32;; a Fortran compiler from -gfortran, g77, ifl, cvf, f95, f90, fortran; +&t-link-gfortran;, &t-link-g77;, &t-link-ifl;, &t-link-cvf;, +&t-link-f95;, &t-link-f90;, &t-link-fortran;; and a static archiver from -mslib, ar, tlib; +&t-link-mslib;, &t-link-ar;, &t-link-tlib;; It also selects all found from the list -msvs, midl. +&t-link-msvs;, &t-link-midl;. </para> <para> On MacOS systems, the default tools list selects (first-found): a C compiler from -gcc, cc; +&t-link-gcc;, &t-link-cc;; a C++ compiler from -g++, cxx; -an assembler 'as'; +&t-link-gXX;, &t-link-cXX;; +an assembler &t-link-as;; a linker from -applelink, gnulink; +&t-link-applelink;, &t-link-gnulink;; a Fortran compiler from -gfortran, f95, f90, g77; -and a static archiver ar. +&t-link-gfortran;, &t-link-f95;, &t-link-f90;, &t-link-g77;; +and a static archiver &t-link-ar;. It also selects all found from the list -m4, rpm. +&t-link-m4;, +<!-- TODO &t-link-rpm; --> rpm. </para> <para> diff --git a/SCons/Tool/docbook/docbook.xml b/SCons/Tool/docbook/docbook.xml index 4c079b7..b0de859 100644 --- a/SCons/Tool/docbook/docbook.xml +++ b/SCons/Tool/docbook/docbook.xml @@ -40,29 +40,29 @@ stylesheet <filename>utils/xmldepend.xsl</filename> by Paul DuBois is used for t <para>Note, that there is no support for XML catalog resolving offered! This tool calls the XSLT processors and PDF renderers with the stylesheets you specified, that's it. The rest lies in your hands and you still have to know what you're doing when -resolving names via a catalog. +resolving names via a catalog. </para> <para>For activating the tool "docbook", you have to add its name to the Environment constructor, like this </para> <screen>env = Environment(tools=['docbook']) </screen> -<para>On its startup, the Docbook tool tries to find a required <literal>xsltproc</literal> processor, and -a PDF renderer, e.g. <literal>fop</literal>. So make sure that these are added to your system's environment -<literal>PATH</literal> and can be called directly, without specifying their full path. +<para>On its startup, the &t-docbook; tool tries to find a required <literal>xsltproc</literal> processor, and +a PDF renderer, e.g. <application>fop</application>. So make sure that these are added to your system's environment +<envar>PATH</envar> and can be called directly without specifying their full path. </para> <para>For the most basic processing of Docbook to HTML, you need to have installed </para> -<itemizedlist><listitem><para>the Python <literal>lxml</literal> binding to <literal>libxml2</literal>, or -</para> +<itemizedlist><listitem><para>the Python <systemitem>lxml</systemitem> +binding to <systemitem>libxml2</systemitem>, or</para> </listitem> -<listitem><para>a standalone XSLT processor, currently detected are <literal>xsltproc</literal>, <literal>saxon</literal>, <literal>saxon-xslt</literal> -and <literal>xalan</literal>. +<listitem><para>a standalone XSLT processor, currently detected are <application>xsltproc</application>, <application>saxon</application>, <application>saxon-xslt</application> +and <application>xalan</application>. </para> </listitem> </itemizedlist> <para>Rendering to PDF requires you to have one of the applications -<literal>fop</literal> or <literal>xep</literal> installed. +<application>fop</application> or <application>xep</application> installed. </para> <para>Creating a HTML or PDF document is very simple and straightforward. Say @@ -93,14 +93,14 @@ Tool uses the given names as file stems, and adds the suffixes for target and so accordingly. </para> </important> -<para>The rules given above are valid for the Builders &b-link-DocbookHtml;, -&b-link-DocbookPdf;, &b-link-DocbookEpub;, &b-link-DocbookSlidesPdf; and &b-link-DocbookXInclude;. For the +<para>The rules given above are valid for the Builders &b-link-DocbookHtml;, +&b-link-DocbookPdf;, &b-link-DocbookEpub;, &b-link-DocbookSlidesPdf; and &b-link-DocbookXInclude;. For the &b-link-DocbookMan; transformation you can specify a target name, but the actual output names are automatically set from the <literal>refname</literal> entries in your XML source. </para> -<para>The Builders &b-link-DocbookHtmlChunked;, &b-link-DocbookHtmlhelp; and +<para>The Builders &b-link-DocbookHtmlChunked;, &b-link-DocbookHtmlhelp; and &b-link-DocbookSlidesHtml; are special, in that: </para> <orderedlist><listitem><para>they create a large set of files, where the exact names and their number depend @@ -112,7 +112,7 @@ XSL transformation is not picked up by the stylesheets. </para> </listitem> </orderedlist> -<para>As a result, there is simply no use in specifying a target HTML name. +<para>As a result, there is simply no use in specifying a target HTML name. So the basic syntax for these builders is always: </para> <screen>env = Environment(tools=['docbook']) @@ -120,7 +120,7 @@ env.DocbookHtmlhelp('manual') </screen> <para>If you want to use a specific XSL file, you can set the -additional <literal>xsl</literal> parameter to your +additional <parameter>xsl</parameter> parameter to your Builder call as follows: </para> <screen>env.DocbookHtml('other.html', 'manual.xml', xsl='html.xsl') @@ -129,21 +129,24 @@ Builder call as follows: e.g. <filename>html.xsl</filename> for HTML and <filename>pdf.xsl</filename> for PDF output, a set of variables for setting the default XSL name is provided. These are: </para> -<screen>DOCBOOK_DEFAULT_XSL_HTML -DOCBOOK_DEFAULT_XSL_HTMLCHUNKED -DOCBOOK_DEFAULT_XSL_HTMLHELP -DOCBOOK_DEFAULT_XSL_PDF -DOCBOOK_DEFAULT_XSL_EPUB -DOCBOOK_DEFAULT_XSL_MAN -DOCBOOK_DEFAULT_XSL_SLIDESPDF -DOCBOOK_DEFAULT_XSL_SLIDESHTML +<screen>DOCBOOK_DEFAULT_XSL_HTML +DOCBOOK_DEFAULT_XSL_HTMLCHUNKED +DOCBOOK_DEFAULT_XSL_HTMLHELP +DOCBOOK_DEFAULT_XSL_PDF +DOCBOOK_DEFAULT_XSL_EPUB +DOCBOOK_DEFAULT_XSL_MAN +DOCBOOK_DEFAULT_XSL_SLIDESPDF +DOCBOOK_DEFAULT_XSL_SLIDESHTML </screen> <para>and you can set them when constructing your environment: </para> -<screen>env = Environment(tools=['docbook'], - DOCBOOK_DEFAULT_XSL_HTML='html.xsl', - DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') -env.DocbookHtml('manual') # now uses html.xsl +<screen> +env = Environment( + tools=['docbook'], + DOCBOOK_DEFAULT_XSL_HTML='html.xsl', + DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl', +) +env.DocbookHtml('manual') # now uses html.xsl </screen> </summary> <sets> @@ -283,7 +286,7 @@ if one of them is installed (<literal>fop</literal> gets checked first). <summary> <para> Additonal command-line flags for the external executable -<literal>xsltproc</literal> (or <literal>saxon</literal>, +<literal>xsltproc</literal> (or <literal>saxon</literal>, <literal>xalan</literal>). </para> </summary> @@ -321,7 +324,7 @@ for <literal>saxon</literal> and <literal>saxon-xslt</literal>, respectively. <summary> <para> The full command-line for the external executable -<literal>xsltproc</literal> (or <literal>saxon</literal>, +<literal>xsltproc</literal> (or <literal>saxon</literal>, <literal>xalan</literal>). </para> </summary> @@ -392,8 +395,8 @@ env.DocbookHtml('manual') <builder name="DocbookHtmlChunked"> <summary> <para> -A pseudo-Builder, providing a Docbook toolchain for chunked HTML output. -It supports the <literal>base.dir</literal> parameter. The +A pseudo-Builder providing a Docbook toolchain for chunked HTML output. +It supports the <parameter>base.dir</parameter> parameter. The <filename>chunkfast.xsl</filename> file (requires "EXSLT") is used as the default stylesheet. Basic syntax: </para> @@ -404,22 +407,23 @@ env.DocbookHtmlChunked('manual') <para> where <filename>manual.xml</filename> is the input file. </para> -<para>If you use the <literal>root.filename</literal> +<para>If you use the <parameter>root.filename</parameter> parameter in your own stylesheets you have to specify the new target name. This ensures that the dependencies get correct, especially for the cleanup via <quote><literal>scons -c</literal></quote>: </para> <screen>env = Environment(tools=['docbook']) env.DocbookHtmlChunked('mymanual.html', 'manual', xsl='htmlchunk.xsl') </screen> -<para>Some basic support for the <literal>base.dir</literal> is provided. You -can add the <literal>base_dir</literal> keyword to your Builder -call, and the given prefix gets prepended to all the created filenames: +<para>Some basic support for the <parameter>base.dir</parameter> parameter +is provided. You can add the <parameter>base_dir</parameter> keyword to +your Builder call, and the given prefix gets prepended to all the +created filenames: </para> <screen>env = Environment(tools=['docbook']) env.DocbookHtmlChunked('manual', xsl='htmlchunk.xsl', base_dir='output/') </screen> <para>Make sure that you don't forget the trailing slash for the base folder, else -your files get renamed only! +your files get renamed only! </para> </summary> </builder> @@ -438,15 +442,15 @@ env.DocbookHtmlhelp('manual') where <filename>manual.xml</filename> is the input file. </para> -<para>If you use the <literal>root.filename</literal> +<para>If you use the <parameter>root.filename</parameter> parameter in your own stylesheets you have to specify the new target name. -This ensures that the dependencies get correct, especially for the cleanup via <quote><literal>scons -c</literal></quote>: +This ensures that the dependencies get correct, especially for the cleanup via <quote><userinput>scons -c</userinput></quote>: </para> <screen>env = Environment(tools=['docbook']) env.DocbookHtmlhelp('mymanual.html', 'manual', xsl='htmlhelp.xsl') </screen> -<para>Some basic support for the <literal>base.dir</literal> parameter -is provided. You can add the <literal>base_dir</literal> keyword to +<para>Some basic support for the <parameter>base.dir</parameter> parameter +is provided. You can add the <parameter>base_dir</parameter> keyword to your Builder call, and the given prefix gets prepended to all the created filenames: </para> @@ -454,7 +458,7 @@ created filenames: env.DocbookHtmlhelp('manual', xsl='htmlhelp.xsl', base_dir='output/') </screen> <para>Make sure that you don't forget the trailing slash for the base folder, else -your files get renamed only! +your files get renamed only! </para> </summary> @@ -513,7 +517,7 @@ Its basic syntax is: env.DocbookMan('manual') </example_commands> <para> -where <filename>manual.xml</filename> is the input file. Note, that +where <filename>manual.xml</filename> is the input file. Note, that you can specify a target name, but the actual output names are automatically set from the <literal>refname</literal> entries in your XML source. </para> @@ -550,25 +554,25 @@ A pseudo-Builder, providing a Docbook toolchain for HTML slides output. env.DocbookSlidesHtml('manual') </example_commands> -<para>If you use the <literal>titlefoil.html</literal> parameter in +<para>If you use the <parameter>titlefoil.html</parameter> parameter in your own stylesheets you have to give the new target name. This ensures -that the dependencies get correct, especially for the cleanup via -<quote><literal>scons -c</literal></quote>: +that the dependencies get correct, especially for the cleanup via +<quote><userinput>scons -c</userinput></quote>: </para> <screen>env = Environment(tools=['docbook']) env.DocbookSlidesHtml('mymanual.html','manual', xsl='slideshtml.xsl') </screen> -<para>Some basic support for the <literal>base.dir</literal> parameter +<para>Some basic support for the <parameter>base.dir</parameter> parameter is provided. You -can add the <literal>base_dir</literal> keyword to your Builder +can add the <parameter>base_dir</parameter> keyword to your Builder call, and the given prefix gets prepended to all the created filenames: </para> <screen>env = Environment(tools=['docbook']) env.DocbookSlidesHtml('manual', xsl='slideshtml.xsl', base_dir='output/') </screen> <para>Make sure that you don't forget the trailing slash for the base folder, else -your files get renamed only! +your files get renamed only! </para> </summary> @@ -596,7 +600,7 @@ A pseudo-Builder, applying a given XSL transformation to the input file. env.DocbookXslt('manual_transformed.xml', 'manual.xml', xsl='transform.xslt') </example_commands> -<para>Note, that this builder requires the <literal>xsl</literal> parameter +<para>Note, that this builder requires the <parameter>xsl</parameter> parameter to be set. </para> </summary> diff --git a/SCons/Tool/dvi.xml b/SCons/Tool/dvi.xml index 3013bbc..ee67e14 100644 --- a/SCons/Tool/dvi.xml +++ b/SCons/Tool/dvi.xml @@ -26,7 +26,7 @@ See its __doc__ string for a discussion of the format. <tool name="dvi"> <summary> <para> -Attaches the &b-DVI; builder to the +Attaches the &b-link-DVI; builder to the construction environment. </para> </summary> diff --git a/SCons/Tool/gas.xml b/SCons/Tool/gas.xml index 5a12401..9cdcdb2 100644 --- a/SCons/Tool/gas.xml +++ b/SCons/Tool/gas.xml @@ -27,7 +27,7 @@ See its __doc__ string for a discussion of the format. <summary> <para> Sets construction variables for the &gas; assembler. -Calls the &t-as; module. +Calls the &t-link-as; tool. </para> </summary> <sets> diff --git a/SCons/Tool/gettext.xml b/SCons/Tool/gettext.xml index c7943b2..b184e44 100644 --- a/SCons/Tool/gettext.xml +++ b/SCons/Tool/gettext.xml @@ -59,8 +59,8 @@ so you're encouraged to see their individual documentation. <para> Each of the above tools provides its own builder(s) which may be used to perform particular activities related to software internationalization. You -may be however interested in <emphasis>top-level</emphasis> builder -&b-Translate; described few paragraphs later. +may be however interested in <emphasis>top-level</emphasis> +&b-link-Translate; builder. </para> <para> diff --git a/SCons/Tool/gs.xml b/SCons/Tool/gs.xml index d05ea9f..6baaa15 100644 --- a/SCons/Tool/gs.xml +++ b/SCons/Tool/gs.xml @@ -27,11 +27,11 @@ See its __doc__ string for a discussion of the format. <summary> <para> This Tool sets the required construction variables for working with -the Ghostscript command. It also registers an appropriate Action -with the PDF Builder (&b-link-PDF;), such that the conversion from +the Ghostscript software. It also registers an appropriate Action +with the &b-link-PDF; Builder, such that the conversion from PS/EPS to PDF happens automatically for the TeX/LaTeX toolchain. -Finally, it adds an explicit Ghostscript Builder (&b-link-Gs;) to the -environment. +Finally, it adds an explicit &b-link-Gs; Builder for Ghostscript +to the environment. </para> </summary> <sets> @@ -47,7 +47,7 @@ environment. <cvar name="GS"> <summary> <para> -The Ghostscript program used, e.g. to convert PostScript to PDF files. +The name of the Ghostscript program used, e.g. to convert PostScript to PDF files. </para> </summary> </cvar> @@ -84,15 +84,18 @@ is <quote><literal>-dNOPAUSE -dBATCH -sDEVICE=pdfwrite</literal></quote> <builder name="Gs"> <summary> <para> -A Builder for explicitly calling the <literal>gs</literal> executable. -Depending on the underlying OS, the different names <literal>gs</literal>, -<literal>gsos2</literal> and <literal>gswin32c</literal> +A Builder for explicitly calling the <application>gs</application> executable. +Depending on the underlying OS, the different names <application>gs</application>, +<application>gsos2</application> and <application>gswin32c</application> are tried. </para> -<example_commands>env = Environment(tools=['gs']) -env.Gs('cover.jpg','scons-scons.pdf', - GSFLAGS='-dNOPAUSE -dBATCH -sDEVICE=jpeg -dFirstPage=1 -dLastPage=1 -q') - ) +<example_commands> +env = Environment(tools=['gs']) +env.Gs( + 'cover.jpg', + 'scons-scons.pdf', + GSFLAGS='-dNOPAUSE -dBATCH -sDEVICE=jpeg -dFirstPage=1 -dLastPage=1 -q', +) </example_commands> </summary> </builder> diff --git a/SCons/Tool/hpcc.xml b/SCons/Tool/hpcc.xml index 85ce09e..a413099 100644 --- a/SCons/Tool/hpcc.xml +++ b/SCons/Tool/hpcc.xml @@ -26,9 +26,9 @@ See its __doc__ string for a discussion of the format. <tool name="hpcc"> <summary> <para> -Set construction variables for the -<application>aCC</application> on HP/UX systems. -Calls the &t-cXX; tool for additional variables. +Set construction variables for +<application>aCC</application> compilers on HP/UX systems. +Calls the &t-link-cXX; tool for additional variables. </para> </summary> <sets> diff --git a/SCons/Tool/intelc.xml b/SCons/Tool/intelc.xml index 49a9296..87958a5 100644 --- a/SCons/Tool/intelc.xml +++ b/SCons/Tool/intelc.xml @@ -28,9 +28,9 @@ See its __doc__ string for a discussion of the format. <para> Sets construction variables for the Intel C/C++ compiler (Linux and Windows, version 7 and later). -Calls the &t-gcc; or &t-msvc; +Calls the &t-link-gcc; or &t-link-msvc; (on Linux and Windows, respectively) -to set underlying variables. +tool to set underlying variables. </para> </summary> <sets> @@ -48,7 +48,7 @@ to set underlying variables. <cvar name="INTEL_C_COMPILER_VERSION"> <summary> <para> -Set by the "intelc" Tool +Set by the &t-link-intelc; Tool to the major version number of the Intel C compiler selected for use. </para> diff --git a/SCons/Tool/link.xml b/SCons/Tool/link.xml index f90a33b..210d946 100644 --- a/SCons/Tool/link.xml +++ b/SCons/Tool/link.xml @@ -245,6 +245,16 @@ set. The linker. See also &cv-link-SHLINK; for linking shared objects. </para> +<para> +On POSIX systems (those using the &t-link-link; tool), +you should normally not change this value as it defaults +to a "smart" linker tool which selects a compiler +driver matching the type of source files in use. +So for example, if you set &cv-link-CXX; to a specific +compiler name, and are compiling C++ sources, +the smartlink function will automatically select the same compiler +for linking. +</para> </summary> </cvar> @@ -323,6 +333,16 @@ set. The linker for programs that use shared libraries. See also &cv-link-LINK; for linking static objects. </para> +<para> +On POSIX systems (those using the &t-link-link; tool), +you should normally not change this value as it defaults +to a "smart" linker tool which selects a compiler +driver matching the type of source files in use. +So for example, if you set &cv-link-SHCXX; to a specific +compiler name, and are compiling C++ sources, +the smartlink function will automatically select the same compiler +for linking. +</para> </summary> </cvar> diff --git a/SCons/Tool/packaging/packaging.xml b/SCons/Tool/packaging/packaging.xml index 59eb52f..8516ca5 100644 --- a/SCons/Tool/packaging/packaging.xml +++ b/SCons/Tool/packaging/packaging.xml @@ -41,7 +41,7 @@ command-line option is also enabled. <summary> <para> Builds software distribution packages. -A <firstterm>Package</firstterm> is a container format which +A <firstterm>package</firstterm> is a container format which includes files to install along with metadata. Packaging is optional, and must be enabled by specifying the &t-link-packaging; tool. For example: |