diff options
author | Mats Wichmann <mats@linux.com> | 2019-08-12 14:46:24 (GMT) |
---|---|---|
committer | Mats Wichmann <mats@linux.com> | 2019-09-07 19:17:06 (GMT) |
commit | 06d79e6c3ba463f1254ce12edad54c7fe94679a7 (patch) | |
tree | 2723b56f205c41d4c6e99b0dce29cb50276f6b2b /src/engine/SCons | |
parent | a9d0c090c02491d7dec0e54688e9a819d0229732 (diff) | |
download | SCons-06d79e6c3ba463f1254ce12edad54c7fe94679a7.zip SCons-06d79e6c3ba463f1254ce12edad54c7fe94679a7.tar.gz SCons-06d79e6c3ba463f1254ce12edad54c7fe94679a7.tar.bz2 |
manpage: clarify that tools=[list] overrides [ci skip]
Also some formatting tweaks, and a couple of typos.
The description of the default tool now lists some
of what that may include.
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'src/engine/SCons')
-rw-r--r-- | src/engine/SCons/Tool/cc.xml | 2 | ||||
-rw-r--r-- | src/engine/SCons/Tool/default.xml | 85 | ||||
-rw-r--r-- | src/engine/SCons/Tool/link.xml | 4 | ||||
-rw-r--r-- | src/engine/SCons/Tool/midl.xml | 2 |
4 files changed, 87 insertions, 6 deletions
diff --git a/src/engine/SCons/Tool/cc.xml b/src/engine/SCons/Tool/cc.xml index 9330436..7ce8b36 100644 --- a/src/engine/SCons/Tool/cc.xml +++ b/src/engine/SCons/Tool/cc.xml @@ -26,7 +26,7 @@ See its __doc__ string for a discussion of the format. <tool name="cc"> <summary> <para> -Sets construction variables for generic POSIX C copmilers. +Sets construction variables for generic POSIX C compilers. </para> </summary> <sets> diff --git a/src/engine/SCons/Tool/default.xml b/src/engine/SCons/Tool/default.xml index 38eb122..fad32ec 100644 --- a/src/engine/SCons/Tool/default.xml +++ b/src/engine/SCons/Tool/default.xml @@ -26,10 +26,89 @@ See its __doc__ string for a discussion of the format. <tool name="default"> <summary> <para> -Sets variables by calling a default list of Tool modules -for the platform on which SCons is running. +Sets constuction variables for a default list of Tool modules. +Include <emphasis role="bold">default</emphasis> +in the tools list to retain +the tools that would have been available if no +<parameter>tools</parameter> parameter were supplied +to an <emphasis role="bold">Environment</emphasis> +or <emphasis role="bold">Clone</emphasis> call. </para> + +<para> +The list of available tools from default is dependent both on +the platform and what software is 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; +variable 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. +</para> + +<para> +On Linux systems, the default tools list selects +(first-found) a C compiler from +gcc, intelc, icc, cc; +a C++ compiler from +g++, intelc, icc, cxx; +an assembler from +gas, nasm, masm; +a linker from +gnulink, ilink; +a Fortran compiler from +gfortran, g77, ifort, ifl, f95, f90, f77; +and a static archiver 'ar'. +It also selects all found from the list +m4, 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; +a C++ compiler from +msvc, intelc, icc, g++, cxx, bcc32; +an assembler from +masm, nasm, gas, 386asm; +a linker from +mslink, gnulink, ilink, linkloc, ilink32; +a Fortran compiler from +gfortran, g77, ifl, cvf, f95, f90, fortran; +and a static archiver from +mslib, ar, tlib; +It also selects all found from the list +msvs, midl. +</para> + +<para> +On MacOS systems, the default tools list selects +(first-found) a C compiler from +gcc, cc; +a C++ compiler from +g++, cxx; +an assembler 'as'; +a linker from +applelink, gnulink; +a Fortran compiler from +gfortran, f95, f90, g77; +and a static archiver 'ar'. +It also selects all found from the list +m4, rpm. +</para> + +<para> +Default lists for other platforms can be found by +examining the source code for &scons;. +</para> + </summary> </tool> - </sconsdoc> diff --git a/src/engine/SCons/Tool/link.xml b/src/engine/SCons/Tool/link.xml index 2f913fe..47d78df 100644 --- a/src/engine/SCons/Tool/link.xml +++ b/src/engine/SCons/Tool/link.xml @@ -26,7 +26,9 @@ See its __doc__ string for a discussion of the format. <tool name="link"> <summary> <para> -Sets construction variables for generic POSIX linkers. +Sets construction variables for generic POSIX linkers. This is +a "smart" linker tool which selects a compiler to complete the linking +based on the type of source file. </para> </summary> <sets> diff --git a/src/engine/SCons/Tool/midl.xml b/src/engine/SCons/Tool/midl.xml index efd83cc..63cf527 100644 --- a/src/engine/SCons/Tool/midl.xml +++ b/src/engine/SCons/Tool/midl.xml @@ -86,7 +86,7 @@ The command line used to pass files to the Microsoft IDL compiler. <summary> <para> The string displayed when -the Microsoft IDL copmiler is called. +the Microsoft IDL compiler is called. If this is not set, then &cv-link-MIDLCOM; (the command line) is displayed. </para> </summary> |