diff options
| author | Steven Knight <knight@baldmt.com> | 2005-11-17 14:23:07 (GMT) |
|---|---|---|
| committer | Steven Knight <knight@baldmt.com> | 2005-11-17 14:23:07 (GMT) |
| commit | aae551ea6f1e3820039f5171d643074f4758cb88 (patch) | |
| tree | b69a29b3c5e16f0b6743947b59e7084221f1e8a1 /src/engine/SCons/Tool | |
| parent | ccf40f2276e48c420f346b489b1c549d30f62df7 (diff) | |
| download | SCons-aae551ea6f1e3820039f5171d643074f4758cb88.zip SCons-aae551ea6f1e3820039f5171d643074f4758cb88.tar.gz SCons-aae551ea6f1e3820039f5171d643074f4758cb88.tar.bz2 | |
Bring CVS back in sync.
Diffstat (limited to 'src/engine/SCons/Tool')
80 files changed, 601 insertions, 150 deletions
diff --git a/src/engine/SCons/Tool/386asm.xml b/src/engine/SCons/Tool/386asm.xml index 2a9d993..bb36048 100644 --- a/src/engine/SCons/Tool/386asm.xml +++ b/src/engine/SCons/Tool/386asm.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="386asm"> <summary> XXX diff --git a/src/engine/SCons/Tool/BitKeeper.xml b/src/engine/SCons/Tool/BitKeeper.xml index 43841a0..3fef72d 100644 --- a/src/engine/SCons/Tool/BitKeeper.xml +++ b/src/engine/SCons/Tool/BitKeeper.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="BitKeeper"> <summary> XXX @@ -14,7 +19,7 @@ The BitKeeper executable. <cvar name="BITKEEPERCOM"> <summary> The command line for -fetching source files using BitKEeper. +fetching source files using BitKeeper. </summary> </cvar> diff --git a/src/engine/SCons/Tool/CVS.xml b/src/engine/SCons/Tool/CVS.xml index 9a07294..9ad5fb5 100644 --- a/src/engine/SCons/Tool/CVS.xml +++ b/src/engine/SCons/Tool/CVS.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="CVS"> <summary> XXX diff --git a/src/engine/SCons/Tool/Perforce.xml b/src/engine/SCons/Tool/Perforce.xml index 247330e..87565af 100644 --- a/src/engine/SCons/Tool/Perforce.xml +++ b/src/engine/SCons/Tool/Perforce.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="Perforce"> <summary> XXX diff --git a/src/engine/SCons/Tool/RCS.xml b/src/engine/SCons/Tool/RCS.xml index 40d972f..5e3b83d 100644 --- a/src/engine/SCons/Tool/RCS.xml +++ b/src/engine/SCons/Tool/RCS.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="RCS"> <summary> XXX diff --git a/src/engine/SCons/Tool/SCCS.xml b/src/engine/SCons/Tool/SCCS.xml index 08aa949..822547c 100644 --- a/src/engine/SCons/Tool/SCCS.xml +++ b/src/engine/SCons/Tool/SCCS.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="SCCS"> <summary> XXX diff --git a/src/engine/SCons/Tool/Subversion.xml b/src/engine/SCons/Tool/Subversion.xml index e5560d1..c3a4f5f 100644 --- a/src/engine/SCons/Tool/Subversion.xml +++ b/src/engine/SCons/Tool/Subversion.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="Subversion"> <summary> XXX diff --git a/src/engine/SCons/Tool/__init__.xml b/src/engine/SCons/Tool/__init__.xml index 86b830c..0cce79b 100644 --- a/src/engine/SCons/Tool/__init__.xml +++ b/src/engine/SCons/Tool/__init__.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <builder name="CFile"> <summary> Builds a C source file given a lex (<filename>.l</filename>) @@ -6,7 +11,8 @@ or yacc (<filename>.y</filename>) input file. The suffix specified by the &cv-CFILESUFFIX; construction variable (<filename>.c</filename> by default) is automatically added to the target -if it is not already present. Example: +if it is not already present. +Example: <example> # builds foo.c @@ -25,7 +31,8 @@ input file. The suffix specified by the &cv-CXXFILESUFFIX; construction variable (<filename>.cc</filename> by default) is automatically added to the target -if it is not already present. Example: +if it is not already present. +Example: <example> # builds foo.cc @@ -44,6 +51,16 @@ builder method. </summary> </builder> +<builder name="LoadableModule"> +<summary> +On most systems, +this is the same as +&b-SharedLibrary;. +On Mac OS X (Darwin) platforms, +this creates a loadable module bundle. +</summary> +</builder> + <builder name="Object"> <summary> A synonym for the @@ -173,7 +190,7 @@ The target object file prefix by default, the same as &cv-OBJPREFIX;) and suffix (specified by the &cv-SHOBJSUFFIX; construction variable) -are automatically added to the target if not already present. +are automatically added to the target if not already present. Examples: <example> @@ -181,6 +198,13 @@ env.SharedObject(target = 'ddd', source = 'ddd.c') env.SharedObject(target = 'eee.o', source = 'eee.cpp') env.SharedObject(target = 'fff.obj', source = 'fff.for') </example> + +Note that the source files will be scanned +according to the suffix mappings in the +<literal>SourceFileScanner</literal> +object. +See the section "Scanner Objects," +below, for a more information. </summary> </builder> @@ -245,6 +269,8 @@ Source files must have one of the following extensions: .FOR Fortran file .fpp Fortran file + C pre-processor .FPP Fortran file + C pre-processor + .m Object C file + .mm Object C++ file .s assembly language file .S WIN32: assembly language file POSIX: assembly language file + C pre-processor @@ -266,6 +292,13 @@ env.StaticObject(target = 'aaa', source = 'aaa.c') env.StaticObject(target = 'bbb.o', source = 'bbb.c++') env.StaticObject(target = 'ccc.obj', source = 'ccc.f') </example> + +Note that the source files will be scanned +according to the suffix mappings in +<literal>SourceFileScanner</literal> +object. +See the section "Scanner Objects," +below, for a more information. </summary> </builder> @@ -314,7 +347,10 @@ SCons also treats files with the suffixes <filename>.c++</filename>, and <filename>.C++</filename> -as C++ files. +as C++ files, +and files with +<filename>.mm</filename> +suffixes as Objective C++ files. On case-sensitive systems (Linux, UNIX, and other POSIX-alikes), SCons also treats <filename>.C</filename> diff --git a/src/engine/SCons/Tool/aixc++.xml b/src/engine/SCons/Tool/aixc++.xml index d386779..2f03aa6 100644 --- a/src/engine/SCons/Tool/aixc++.xml +++ b/src/engine/SCons/Tool/aixc++.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="aixc++"> <summary> XXX diff --git a/src/engine/SCons/Tool/aixcc.xml b/src/engine/SCons/Tool/aixcc.xml index cb27adb..a7a043c 100644 --- a/src/engine/SCons/Tool/aixcc.xml +++ b/src/engine/SCons/Tool/aixcc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="aixcc"> <summary> XXX diff --git a/src/engine/SCons/Tool/aixf77.xml b/src/engine/SCons/Tool/aixf77.xml index 7e7988c..9043b66 100644 --- a/src/engine/SCons/Tool/aixf77.xml +++ b/src/engine/SCons/Tool/aixf77.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="aixf77"> <summary> XXX diff --git a/src/engine/SCons/Tool/aixlink.xml b/src/engine/SCons/Tool/aixlink.xml index 378dcbf..a1aa05b 100644 --- a/src/engine/SCons/Tool/aixlink.xml +++ b/src/engine/SCons/Tool/aixlink.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="aixlink"> <summary> XXX diff --git a/src/engine/SCons/Tool/applelink.xml b/src/engine/SCons/Tool/applelink.xml index 13eea31..b9ea63d 100644 --- a/src/engine/SCons/Tool/applelink.xml +++ b/src/engine/SCons/Tool/applelink.xml @@ -1,4 +1,9 @@ -<!-- Copyright (c) 2001, 2002, 2003, 2004 The SCons Foundation --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <cvar name="FRAMEWORKSFLAGS">"> <summary> On Mac OS X with gcc, diff --git a/src/engine/SCons/Tool/ar.xml b/src/engine/SCons/Tool/ar.xml index de3246f..baebd27 100644 --- a/src/engine/SCons/Tool/ar.xml +++ b/src/engine/SCons/Tool/ar.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="ar"> <summary> XXX diff --git a/src/engine/SCons/Tool/as.xml b/src/engine/SCons/Tool/as.xml index a9395df..a2447bd 100644 --- a/src/engine/SCons/Tool/as.xml +++ b/src/engine/SCons/Tool/as.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="as"> <summary> XXX diff --git a/src/engine/SCons/Tool/bcc32.xml b/src/engine/SCons/Tool/bcc32.xml index ded614c..1cdb9c0 100644 --- a/src/engine/SCons/Tool/bcc32.xml +++ b/src/engine/SCons/Tool/bcc32.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="bcc32"> <summary> XXX diff --git a/src/engine/SCons/Tool/c++.xml b/src/engine/SCons/Tool/c++.xml index eaa8e6c..eb0a8fe 100644 --- a/src/engine/SCons/Tool/c++.xml +++ b/src/engine/SCons/Tool/c++.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="c++"> <summary> XXX diff --git a/src/engine/SCons/Tool/cc.xml b/src/engine/SCons/Tool/cc.xml index fb688ad..84980db 100644 --- a/src/engine/SCons/Tool/cc.xml +++ b/src/engine/SCons/Tool/cc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="cc"> <summary> XXX @@ -71,6 +76,7 @@ The default list is: [".c", ".C", ".cxx", ".cpp", ".c++", ".cc", ".h", ".H", ".hxx", ".hpp", ".hh", ".F", ".fpp", ".FPP", + ".m", ".mm", ".S", ".spp", ".SPP"] </example> </summary> diff --git a/src/engine/SCons/Tool/cvf.xml b/src/engine/SCons/Tool/cvf.xml index bd848ae..9acde9b 100644 --- a/src/engine/SCons/Tool/cvf.xml +++ b/src/engine/SCons/Tool/cvf.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="cvf"> <summary> XXX diff --git a/src/engine/SCons/Tool/default.xml b/src/engine/SCons/Tool/default.xml index 371e5bc..a4da87a 100644 --- a/src/engine/SCons/Tool/default.xml +++ b/src/engine/SCons/Tool/default.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="default"> <summary> XXX diff --git a/src/engine/SCons/Tool/dmd.xml b/src/engine/SCons/Tool/dmd.xml index 99ca8d9..62ab78e 100644 --- a/src/engine/SCons/Tool/dmd.xml +++ b/src/engine/SCons/Tool/dmd.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="dmd"> <summary> XXX diff --git a/src/engine/SCons/Tool/dvipdf.xml b/src/engine/SCons/Tool/dvipdf.xml index fbb4933..4d82ffe 100644 --- a/src/engine/SCons/Tool/dvipdf.xml +++ b/src/engine/SCons/Tool/dvipdf.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="dvipdf"> <summary> XXX diff --git a/src/engine/SCons/Tool/dvips.xml b/src/engine/SCons/Tool/dvips.xml index c290469..cb0d7d8 100644 --- a/src/engine/SCons/Tool/dvips.xml +++ b/src/engine/SCons/Tool/dvips.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="dvips"> <summary> XXX diff --git a/src/engine/SCons/Tool/f77.xml b/src/engine/SCons/Tool/f77.xml index caf959f..c077175 100644 --- a/src/engine/SCons/Tool/f77.xml +++ b/src/engine/SCons/Tool/f77.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="f77"> <summary> XXX diff --git a/src/engine/SCons/Tool/f90.xml b/src/engine/SCons/Tool/f90.xml index b2f0857..5c252cc 100644 --- a/src/engine/SCons/Tool/f90.xml +++ b/src/engine/SCons/Tool/f90.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="f90"> <summary> XXX diff --git a/src/engine/SCons/Tool/f95.xml b/src/engine/SCons/Tool/f95.xml index df74422..86331a4 100644 --- a/src/engine/SCons/Tool/f95.xml +++ b/src/engine/SCons/Tool/f95.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="f95"> <summary> XXX diff --git a/src/engine/SCons/Tool/fortran.xml b/src/engine/SCons/Tool/fortran.xml index bfc34fa..c472343 100644 --- a/src/engine/SCons/Tool/fortran.xml +++ b/src/engine/SCons/Tool/fortran.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="fortran"> <summary> XXX @@ -16,7 +21,7 @@ for all versions of Fortran. <summary> The command line used to compile a Fortran source file to an object file. By default, any options specified -in the &cv-FORTRANFLAGS;, &cv-CPPFLAGS;, &cv-_CPPDEFFLAGS;, +in the &cv-FORTRANFLAGS;, &cv-CPPFLAGS;, &cv-_CPPDEFFLAGS;, &cv-_FORTRANMODFLAG;, and &cv-_FORTRANINCFLAGS; construction variables are included on this command line. </summary> @@ -51,7 +56,7 @@ for the variables that expand those options. <summary> An automatically-generated construction variable containing the Fortran compiler command-line options -for specifying directories to be searched for include +for specifying directories to be searched for include files and module files. The value of &cv-_FORTRANINCFLAGS; is created by prepending/appending &cv-INCPREFIX; and &cv-INCSUFFIX; @@ -63,8 +68,8 @@ of each directory in &cv-FORTRANPATH;. <cvar name="FORTRANMODDIR"> <summary> Directory location where the Fortran compiler should place -any module files it generates. This variable is empty, by default. Some -Fortran compilers will internally append this directory in the search path +any module files it generates. This variable is empty, by default. Some +Fortran compilers will internally append this directory in the search path for module files, as well. </summary> </cvar> @@ -94,7 +99,7 @@ when the &cv-_FORTRANMODFLAG; variables is automatically generated. An automatically-generated construction variable containing the Fortran compiler command-line option for specifying the directory location where the Fortran -compiler should place any module files that happen to get +compiler should place any module files that happen to get generated during compilation. The value of &cv-_FORTRANMODFLAG; is created by prepending/appending &cv-FORTRANMODDIRPREFIX; and &cv-FORTRANMODDIRSUFFIX; @@ -146,7 +151,7 @@ to look-up a directory relative to the root of the source tree use #: env = Environment(FORTRANPATH='#/include') </example> -The directory look-up can also be forced using the +The directory look-up can also be forced using the &Dir;() function: @@ -178,7 +183,7 @@ env = Environment(FORTRANCOM="my_compiler $_FORTRANINCFLAGS -c -o $TARGET $SOURC <cvar name="FORTRANPPCOM"> <summary> The command line used to compile a Fortran source file to an object file -after first running the file through the C preprocessor. +after first running the file through the C preprocessor. By default, any options specified in the &cv-FORTRANFLAGS;, &cv-CPPFLAGS;, _CPPDEFFLAGS, &cv-_FORTRANMODFLAG;, and &cv-_FORTRANINCFLAGS; construction variables are included on this command line. diff --git a/src/engine/SCons/Tool/g++.xml b/src/engine/SCons/Tool/g++.xml index b6fb5b0..4991811 100644 --- a/src/engine/SCons/Tool/g++.xml +++ b/src/engine/SCons/Tool/g++.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="g++"> <summary> XXX diff --git a/src/engine/SCons/Tool/g77.xml b/src/engine/SCons/Tool/g77.xml index 94f415a..6357f94 100644 --- a/src/engine/SCons/Tool/g77.xml +++ b/src/engine/SCons/Tool/g77.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="g77"> <summary> XXX diff --git a/src/engine/SCons/Tool/gas.xml b/src/engine/SCons/Tool/gas.xml index 29179e2..19ad1a9 100644 --- a/src/engine/SCons/Tool/gas.xml +++ b/src/engine/SCons/Tool/gas.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="gas"> <summary> XXX diff --git a/src/engine/SCons/Tool/gcc.xml b/src/engine/SCons/Tool/gcc.xml index 51dac07..15f19cf 100644 --- a/src/engine/SCons/Tool/gcc.xml +++ b/src/engine/SCons/Tool/gcc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="gcc"> <summary> XXX diff --git a/src/engine/SCons/Tool/gnulink.xml b/src/engine/SCons/Tool/gnulink.xml index d7c1a42..d454af4 100644 --- a/src/engine/SCons/Tool/gnulink.xml +++ b/src/engine/SCons/Tool/gnulink.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="gnulink"> <summary> XXX diff --git a/src/engine/SCons/Tool/gs.xml b/src/engine/SCons/Tool/gs.xml index 377bfc3..d4840d6 100644 --- a/src/engine/SCons/Tool/gs.xml +++ b/src/engine/SCons/Tool/gs.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="gs"> <summary> XXX diff --git a/src/engine/SCons/Tool/hpc++.xml b/src/engine/SCons/Tool/hpc++.xml index 5c13718..ca0314c 100644 --- a/src/engine/SCons/Tool/hpc++.xml +++ b/src/engine/SCons/Tool/hpc++.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="hpc++"> <summary> XXX diff --git a/src/engine/SCons/Tool/hpcc.xml b/src/engine/SCons/Tool/hpcc.xml index db2fccd..9f63b55 100644 --- a/src/engine/SCons/Tool/hpcc.xml +++ b/src/engine/SCons/Tool/hpcc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="hpcc"> <summary> XXX diff --git a/src/engine/SCons/Tool/hplink.xml b/src/engine/SCons/Tool/hplink.xml index 71f5e22..1bd3b78 100644 --- a/src/engine/SCons/Tool/hplink.xml +++ b/src/engine/SCons/Tool/hplink.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="hplink"> <summary> XXX diff --git a/src/engine/SCons/Tool/icc.xml b/src/engine/SCons/Tool/icc.xml index a6fdea2..c41486e 100644 --- a/src/engine/SCons/Tool/icc.xml +++ b/src/engine/SCons/Tool/icc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="icc"> <summary> XXX diff --git a/src/engine/SCons/Tool/icl.xml b/src/engine/SCons/Tool/icl.xml index be20912..5b8c355 100644 --- a/src/engine/SCons/Tool/icl.xml +++ b/src/engine/SCons/Tool/icl.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="icl"> <summary> XXX diff --git a/src/engine/SCons/Tool/ifl.xml b/src/engine/SCons/Tool/ifl.xml index 34dfecb..4b5b912 100644 --- a/src/engine/SCons/Tool/ifl.xml +++ b/src/engine/SCons/Tool/ifl.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="ifl"> <summary> XXX diff --git a/src/engine/SCons/Tool/ifort.xml b/src/engine/SCons/Tool/ifort.xml index 2cb889b..0303dec 100644 --- a/src/engine/SCons/Tool/ifort.xml +++ b/src/engine/SCons/Tool/ifort.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="ifort"> <summary> XXX diff --git a/src/engine/SCons/Tool/ilink.xml b/src/engine/SCons/Tool/ilink.xml index 4f86883..03acfa4 100644 --- a/src/engine/SCons/Tool/ilink.xml +++ b/src/engine/SCons/Tool/ilink.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="ilink"> <summary> XXX diff --git a/src/engine/SCons/Tool/ilink32.xml b/src/engine/SCons/Tool/ilink32.xml index 0d62be4..370d046 100644 --- a/src/engine/SCons/Tool/ilink32.xml +++ b/src/engine/SCons/Tool/ilink32.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="ilink32"> <summary> XXX diff --git a/src/engine/SCons/Tool/intelc.xml b/src/engine/SCons/Tool/intelc.xml index 47cfbec..0141c22 100644 --- a/src/engine/SCons/Tool/intelc.xml +++ b/src/engine/SCons/Tool/intelc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="intelc"> <summary> XXX diff --git a/src/engine/SCons/Tool/jar.xml b/src/engine/SCons/Tool/jar.xml index b89468d..45d9ebc 100644 --- a/src/engine/SCons/Tool/jar.xml +++ b/src/engine/SCons/Tool/jar.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="jar"> <summary> XXX diff --git a/src/engine/SCons/Tool/javac.xml b/src/engine/SCons/Tool/javac.xml index 9cd40b5..86fd507 100644 --- a/src/engine/SCons/Tool/javac.xml +++ b/src/engine/SCons/Tool/javac.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="javac"> <summary> XXX diff --git a/src/engine/SCons/Tool/javah.xml b/src/engine/SCons/Tool/javah.xml index 7699784..84d0068 100644 --- a/src/engine/SCons/Tool/javah.xml +++ b/src/engine/SCons/Tool/javah.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="javah"> <summary> XXX diff --git a/src/engine/SCons/Tool/latex.xml b/src/engine/SCons/Tool/latex.xml index b8b1bb3..96c0f4a 100644 --- a/src/engine/SCons/Tool/latex.xml +++ b/src/engine/SCons/Tool/latex.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="latex"> <summary> XXX diff --git a/src/engine/SCons/Tool/lex.xml b/src/engine/SCons/Tool/lex.xml index 3fb62e1..51401dc 100644 --- a/src/engine/SCons/Tool/lex.xml +++ b/src/engine/SCons/Tool/lex.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="lex"> <summary> XXX diff --git a/src/engine/SCons/Tool/link.xml b/src/engine/SCons/Tool/link.xml index 420a5b7..52694ad 100644 --- a/src/engine/SCons/Tool/link.xml +++ b/src/engine/SCons/Tool/link.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="link"> <summary> XXX diff --git a/src/engine/SCons/Tool/linkloc.xml b/src/engine/SCons/Tool/linkloc.xml index 12a9d50..58ffc48 100644 --- a/src/engine/SCons/Tool/linkloc.xml +++ b/src/engine/SCons/Tool/linkloc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="linkloc"> <summary> XXX diff --git a/src/engine/SCons/Tool/m4.xml b/src/engine/SCons/Tool/m4.xml index 1f91770..7a0f9c3 100644 --- a/src/engine/SCons/Tool/m4.xml +++ b/src/engine/SCons/Tool/m4.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="m4"> <summary> XXX diff --git a/src/engine/SCons/Tool/masm.xml b/src/engine/SCons/Tool/masm.xml index 82c14cf..ee1ed1d 100644 --- a/src/engine/SCons/Tool/masm.xml +++ b/src/engine/SCons/Tool/masm.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="masm"> <summary> XXX diff --git a/src/engine/SCons/Tool/midl.xml b/src/engine/SCons/Tool/midl.xml index 4d5c7e0..8885785 100644 --- a/src/engine/SCons/Tool/midl.xml +++ b/src/engine/SCons/Tool/midl.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="midl"> <summary> XXX diff --git a/src/engine/SCons/Tool/mingw.xml b/src/engine/SCons/Tool/mingw.xml index 273a861..9f9cf1f 100644 --- a/src/engine/SCons/Tool/mingw.xml +++ b/src/engine/SCons/Tool/mingw.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="mingw"> <summary> XXX diff --git a/src/engine/SCons/Tool/mslib.xml b/src/engine/SCons/Tool/mslib.xml index 7da4365..9d56fd5 100644 --- a/src/engine/SCons/Tool/mslib.xml +++ b/src/engine/SCons/Tool/mslib.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="mslib"> <summary> XXX diff --git a/src/engine/SCons/Tool/mslink.xml b/src/engine/SCons/Tool/mslink.xml index 82249e7..2b901c6 100644 --- a/src/engine/SCons/Tool/mslink.xml +++ b/src/engine/SCons/Tool/mslink.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="mslink"> <summary> XXX @@ -26,7 +31,8 @@ tools other than Microsoft Visual C++. When this variable is defined SCons will add options to the compiler and linker command line to cause them to generate external debugging information, and will also set up the -dependencies for the PDB file. Example: +dependencies for the PDB file. +Example: <example> env['PDB'] = 'hello.pdb' diff --git a/src/engine/SCons/Tool/msvc.xml b/src/engine/SCons/Tool/msvc.xml index 76529b1..252d962 100644 --- a/src/engine/SCons/Tool/msvc.xml +++ b/src/engine/SCons/Tool/msvc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="msvc"> <summary> XXX @@ -12,7 +17,7 @@ Calling this builder method returns a list of two targets: the PCH as the first element, and the object file as the second element. Normally the object file is ignored. This builder method is only -provided when Microsoft Visual C++ is being used as the compiler. +provided when Microsoft Visual C++ is being used as the compiler. The PCH builder method is generally used in conjuction with the PCH construction variable to force object files to use the precompiled header: @@ -29,11 +34,12 @@ Builds a Microsoft Visual C++ resource file. This builder method is only provided when Microsoft Visual C++ or MinGW is being used as the compiler. The <filename>.res</filename> -(or +(or <filename>.o</filename> for MinGW) suffix is added to the target name if no other suffix is given. The source -file is scanned for implicit dependencies as though it were a C file. Example: +file is scanned for implicit dependencies as though it were a C file. +Example: <example> env.RES('resource.rc') @@ -48,7 +54,8 @@ object files. This variable is ignored by tools other than Microsoft Visual C++. When this variable is defined SCons will add options to the compiler command line to cause it to use the precompiled header, and will also set up the -dependencies for the PCH file. Example: +dependencies for the PCH file. +Example: <example> env['PCH'] = 'StdAfx.pch' diff --git a/src/engine/SCons/Tool/msvs.xml b/src/engine/SCons/Tool/msvs.xml index 9af0960..babc20f 100644 --- a/src/engine/SCons/Tool/msvs.xml +++ b/src/engine/SCons/Tool/msvs.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="msvs"> <summary> XXX @@ -12,7 +17,7 @@ and by default builds a solution file as well. This builds a Visual Studio project file, based on the version of Visual Studio that is configured (either the latest installed version, -or the version specified by +or the version specified by &cv-MSVS_VERSION; in the Environment constructor). For Visual Studio 6, it will generate a @@ -43,7 +48,7 @@ Builder (see below). It takes several lists of filenames to be placed into the project file. -These are currently these are limited to +These are currently limited to <literal>srcs</literal>, <literal>incs</literal>, <literal>localincs</literal>, @@ -60,7 +65,8 @@ In addition to the above lists of values (which are all optional, although not specifying any of them results in an empty project file), the following values may be specified: -<literal>target</literal>: The name of the target +<literal>target</literal>: +The name of the target <filename>.dsp</filename> or <filename>.vcproj</filename> @@ -88,7 +94,7 @@ character: The default target platform is Win32. Multiple calls to &b-MSVSProject; - with different variants are allowed; +with different variants are allowed; all variants will be added to the project file with their appropriate build targets and sources. @@ -133,15 +139,15 @@ Builds a Microsoft Visual Studio solution file. This builds a Visual Studio solution file, based on the version of Visual Studio that is configured (either the latest installed version, -or the version specified by +or the version specified by &cv-MSVS_VERSION; in the construction environment). For Visual Studio 6, it will generate a -<filename>dsw</filename> +<filename>.dsw</filename> file. For Visual Studio 7 (.NET), it will generate a -<filename>sln</filename> +<filename>.sln</filename> file. The following values must be specified: @@ -185,35 +191,35 @@ local.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'], When the Microsoft Visual Studio tools are initialized, they set up this dictionary with the following keys: -<envar>VERSION</envar> +<envar>VERSION</envar>: the version of MSVS being used (can be set via MSVS_VERSION) -<envar>VERSIONS</envar> +<envar>VERSIONS</envar>: the available versions of MSVS installed -<envar>VCINSTALLDIR</envar> +<envar>VCINSTALLDIR</envar>: installed directory of Visual C++ -<envar>VSINSTALLDIR</envar> +<envar>VSINSTALLDIR</envar>: installed directory of Visual Studio -<envar>FRAMEWORKDIR</envar> +<envar>FRAMEWORKDIR</envar>: installed directory of the .NET framework -<envar>FRAMEWORKVERSIONS</envar> +<envar>FRAMEWORKVERSIONS</envar>: list of installed versions of the .NET framework, sorted latest to oldest. -<envar>FRAMEWORKVERSION</envar> +<envar>FRAMEWORKVERSION</envar>: latest installed version of the .NET framework -<envar>FRAMEWORKSDKDIR</envar> +<envar>FRAMEWORKSDKDIR</envar>: installed location of the .NET SDK. -<envar>PLATFORMSDKDIR</envar> +<envar>PLATFORMSDKDIR</envar>: installed location of the Platform SDK. -<envar>PLATFORMSDK_MODULES</envar> +<envar>PLATFORMSDK_MODULES</envar>: dictionary of installed Platform SDK modules, where the dictionary keys are keywords for the various modules, and the values are 2-tuples where the first is the release date, and the @@ -239,18 +245,18 @@ minimal set of paths needed to run the tools successfully. For VS6, the mininimal set is: <example> - INCLUDE:'VSDir\VC98\ATL\include;VSDir\VC98\MFC\include;VSDir\VC98\include' - LIB:'VSDir\VC98\MFC\lib;VSDir\VC98\lib' - PATH:'VSDir\Common\MSDev98\bin;VSDir\VC98\bin' + INCLUDE:'<VSDir>\VC98\ATL\include;<VSDir>\VC98\MFC\include;<VSDir>\VC98\include' + LIB:'<VSDir>\VC98\MFC\lib;<VSDir>\VC98\lib' + PATH:'<VSDir>\Common\MSDev98\bin;<VSDir>\VC98\bin' </example> For VS7, it is: <example> - INCLUDE:'VSDir\Vc7\atlmfc\include;VSDir\Vc7\include' - LIB:'VSDir\Vc7\atlmfc\lib;VSDir\Vc7\lib' - PATH:'VSDir\Common7\Tools\bin;VSDir\Common7\Tools;VSDir\Vc7\bin' + INCLUDE:'<VSDir>\Vc7\atlmfc\include;<VSDir>\Vc7\include' + LIB:'<VSDir>\Vc7\atlmfc\lib;<VSDir>\Vc7\lib' + PATH:'<VSDir>\Common7\Tools\bin;<VSDir>\Common7\Tools;<VSDir>\Vc7\bin' </example> -Where 'VSDir' is the installed location of Visual Studio. +Where '<VSDir>' is the installed location of Visual Studio. </summary> </cvar> @@ -260,7 +266,7 @@ The string placed in a generated Microsoft Visual Studio solution file as the value of the <literal>SccProjectFilePathRelativizedFromConnection0</literal> -and +and <literal>SccProjectFilePathRelativizedFromConnection1</literal> attributes of the <literal>GlobalSection(SourceCodeControl)</literal> @@ -385,7 +391,7 @@ directory to the default <envar>LIB</envar> external environment variable. The current default value is -<literal>1</literal> +<literal>1</literal>, which means these directories are added to the paths by default. This default value is likely to change @@ -413,7 +419,7 @@ installed on your machine. So, if you have version 6 and version 7 (MSVS .NET) installed, it will prefer version 7. You can override this by -specifying the +specifying the <envar>MSVS_VERSION</envar> variable in the Environment initialization, setting it to the appropriate version ('6.0' or '7.0', for example). diff --git a/src/engine/SCons/Tool/mwcc.xml b/src/engine/SCons/Tool/mwcc.xml index 83eaab3..443eda7 100644 --- a/src/engine/SCons/Tool/mwcc.xml +++ b/src/engine/SCons/Tool/mwcc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="mwcc"> <summary> XXX diff --git a/src/engine/SCons/Tool/mwld.xml b/src/engine/SCons/Tool/mwld.xml index ade9848..9943927 100644 --- a/src/engine/SCons/Tool/mwld.xml +++ b/src/engine/SCons/Tool/mwld.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="mwld"> <summary> XXX diff --git a/src/engine/SCons/Tool/nasm.xml b/src/engine/SCons/Tool/nasm.xml index 328386e..071f537 100644 --- a/src/engine/SCons/Tool/nasm.xml +++ b/src/engine/SCons/Tool/nasm.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="nasm"> <summary> XXX diff --git a/src/engine/SCons/Tool/pdflatex.xml b/src/engine/SCons/Tool/pdflatex.xml index 7878079..e9fe793 100644 --- a/src/engine/SCons/Tool/pdflatex.xml +++ b/src/engine/SCons/Tool/pdflatex.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="pdflatex"> <summary> XXX diff --git a/src/engine/SCons/Tool/pdftex.xml b/src/engine/SCons/Tool/pdftex.xml index 701a280..47e4138 100644 --- a/src/engine/SCons/Tool/pdftex.xml +++ b/src/engine/SCons/Tool/pdftex.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="pdftex"> <summary> XXX diff --git a/src/engine/SCons/Tool/qt.xml b/src/engine/SCons/Tool/qt.xml index b5335b6..6a4ac78 100644 --- a/src/engine/SCons/Tool/qt.xml +++ b/src/engine/SCons/Tool/qt.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="qt"> <summary> XXX @@ -7,8 +12,8 @@ XXX <builder name="Moc"> <summary> -Builds an output file from a moc input file. Moc input files are either -header files or cxx files. This builder is only available after using the +Builds an output file from a moc input file. Moc input files are either +header files or cxx files. This builder is only available after using the tool 'qt'. See the &cv-QTDIR; variable for more information. Example: @@ -23,7 +28,7 @@ env.Moc('foo.cpp') # generates foo.moc <summary> Builds a header file, an implementation file and a moc file from an ui file. and returns the corresponding nodes in the above order. -This builder is only available after using the tool 'qt'. Note: you can +This builder is only available after using the tool 'qt'. Note: you can specify <filename>.ui</filename> files directly as source files to the &b-Program;, &b-Library; and &b-SharedLibrary; builders @@ -63,38 +68,41 @@ Environment(tools=['default','qt']) The qt tool supports the following operations: -.B Automatic moc file generation from header files. +<emphasis Role="strong">Automatic moc file generation from header files.</emphasis> You do not have to specify moc files explicitly, the tool does it for you. However, there are a few preconditions to do so: Your header file must have the same filebase as your implementation file and must stay in the same -directory. It must have one of the suffixes .h, .hpp, .H, .hxx, .hh. You +directory. It must have one of the suffixes .h, .hpp, .H, .hxx, .hh. You can turn off automatic moc file generation by setting QT_AUTOSCAN to 0. See also the corresponding builder method .B Moc() -.B Automatic moc file generation from cxx files. -As stated in the qt documentation, include the moc file at the end of +<emphasis Role="strong">Automatic moc file generation from cxx files.</emphasis> +As stated in the qt documentation, include the moc file at the end of the cxx file. Note that you have to include the file, which is generated -by the transformation ${QT_MOCCXXPREFIX}basename${QT_MOCCXXSUFFIX}, by default -basename.moc. A warning is generated after building the moc file, if you -do not include the correct file. If you are using BuildDir, you may -need to specify duplicate=1. You can turn off automatic moc file generation -by setting QT_AUTOSCAN to 0. See also the corresponding builder method -.B Moc() - -.B Automatic handling of .ui files. +by the transformation ${QT_MOCCXXPREFIX}<basename>${QT_MOCCXXSUFFIX}, by default +<basename>.moc. A warning is generated after building the moc file, if you +do not include the correct file. If you are using BuildDir, you may +need to specify duplicate=1. You can turn off automatic moc file generation +by setting QT_AUTOSCAN to 0. See also the corresponding +&b-Moc; +builder method. + +<emphasis Role="strong">Automatic handling of .ui files.</emphasis> The implementation files generated from .ui files are handled much the same as yacc or lex files. Each .ui file given as a source of Program, Library or -SharedLibrary will generate three files, the declaration file, the -implementation file and a moc file. Because there are also generated headers, -you may need to specify duplicate=1 in calls to BuildDir. See also the corresponding builder method -.B Uic() +SharedLibrary will generate three files, the declaration file, the +implementation file and a moc file. Because there are also generated headers, +you may need to specify duplicate=1 in calls to BuildDir. +See also the corresponding +&b-Uic; +builder method. </summary> </cvar> <cvar name="QT_AUTOSCAN"> <summary> -Turn off scanning for mocable files. Use the Moc Builder to explicitely +Turn off scanning for mocable files. Use the Moc Builder to explicitely specify files to run moc on. </summary> </cvar> @@ -131,7 +139,7 @@ this variable to None, the tool won't change the &cv-LIBS; variable. <cvar name="QT_LIBPATH"> <summary> The path where the qt libraries are installed. -The default value is '&cv-QTDIR;/lib'. +The default value is '&cv-QTDIR;/lib'. Note: If you set this variable to None, the tool won't change the &cv-LIBPATH; construction variable. </summary> @@ -139,7 +147,7 @@ construction variable. <cvar name="QT_MOC"> <summary> -Default value is '&cv-QT_BINPATH;/bin/moc'. +Default value is '&cv-QT_BINPATH;/moc'. </summary> </cvar> @@ -151,7 +159,7 @@ Default value is ''. Prefix for moc output files, when source is a cxx file. <cvar name="QT_MOCCXXSUFFIX"> <summary> -Default value is '.moc'. Suffix for moc output files, when source is a cxx +Default value is '.moc'. Suffix for moc output files, when source is a cxx file. </summary> </cvar> @@ -262,7 +270,7 @@ Default value is 'uic_'. Prefix for uic generated implementation files. <cvar name="QT_UICIMPLSUFFIX"> <summary> -Default value is '&cv-CXXFILESUFFIX;'. Suffix for uic generated implementation +Default value is '&cv-CXXFILESUFFIX;'. Suffix for uic generated implementation files. </summary> </cvar> diff --git a/src/engine/SCons/Tool/rmic.xml b/src/engine/SCons/Tool/rmic.xml index 390aaaf..1fe4bd8 100644 --- a/src/engine/SCons/Tool/rmic.xml +++ b/src/engine/SCons/Tool/rmic.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="rmic"> <summary> XXX diff --git a/src/engine/SCons/Tool/rpcgen.xml b/src/engine/SCons/Tool/rpcgen.xml index 9fdf13e..74fc3be 100644 --- a/src/engine/SCons/Tool/rpcgen.xml +++ b/src/engine/SCons/Tool/rpcgen.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="rpcgen"> <summary> XXX diff --git a/src/engine/SCons/Tool/sgiar.xml b/src/engine/SCons/Tool/sgiar.xml index cd1d414..ccea1ca 100644 --- a/src/engine/SCons/Tool/sgiar.xml +++ b/src/engine/SCons/Tool/sgiar.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="sgiar"> <summary> XXX diff --git a/src/engine/SCons/Tool/sgic++.xml b/src/engine/SCons/Tool/sgic++.xml index 318ebbf..a507f79 100644 --- a/src/engine/SCons/Tool/sgic++.xml +++ b/src/engine/SCons/Tool/sgic++.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="sgic++"> <summary> XXX diff --git a/src/engine/SCons/Tool/sgicc.xml b/src/engine/SCons/Tool/sgicc.xml index bd752ec..285ae8c 100644 --- a/src/engine/SCons/Tool/sgicc.xml +++ b/src/engine/SCons/Tool/sgicc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="sgicc"> <summary> XXX diff --git a/src/engine/SCons/Tool/sgilink.xml b/src/engine/SCons/Tool/sgilink.xml index 64eecb8..8fa8f7d 100644 --- a/src/engine/SCons/Tool/sgilink.xml +++ b/src/engine/SCons/Tool/sgilink.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="sgilink"> <summary> XXX diff --git a/src/engine/SCons/Tool/sunar.xml b/src/engine/SCons/Tool/sunar.xml index b94443c..e22563d 100644 --- a/src/engine/SCons/Tool/sunar.xml +++ b/src/engine/SCons/Tool/sunar.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="sunar"> <summary> XXX diff --git a/src/engine/SCons/Tool/sunc++.xml b/src/engine/SCons/Tool/sunc++.xml index fcd6b0a..c18dd90 100644 --- a/src/engine/SCons/Tool/sunc++.xml +++ b/src/engine/SCons/Tool/sunc++.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="sunc++"> <summary> XXX diff --git a/src/engine/SCons/Tool/suncc.xml b/src/engine/SCons/Tool/suncc.xml index ab86294..9f6d340 100644 --- a/src/engine/SCons/Tool/suncc.xml +++ b/src/engine/SCons/Tool/suncc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="suncc"> <summary> XXX diff --git a/src/engine/SCons/Tool/sunlink.xml b/src/engine/SCons/Tool/sunlink.xml index 127651e..6cad24f 100644 --- a/src/engine/SCons/Tool/sunlink.xml +++ b/src/engine/SCons/Tool/sunlink.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="sunlink"> <summary> XXX diff --git a/src/engine/SCons/Tool/swig.xml b/src/engine/SCons/Tool/swig.xml index 5c08412..0bdda96 100644 --- a/src/engine/SCons/Tool/swig.xml +++ b/src/engine/SCons/Tool/swig.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="swig"> <summary> XXX diff --git a/src/engine/SCons/Tool/tar.xml b/src/engine/SCons/Tool/tar.xml index c00910a..88265dc 100644 --- a/src/engine/SCons/Tool/tar.xml +++ b/src/engine/SCons/Tool/tar.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="tar"> <summary> XXX @@ -17,6 +22,12 @@ for a given target; each additional call adds to the list of entries that will be built into the archive. +Any source directories will +be scanned for changes to +any on-disk files, +regardless of whether or not +&scons; +knows about them from other Builder or function calls. <example> env.Tar('src.tar', 'src') diff --git a/src/engine/SCons/Tool/tex.xml b/src/engine/SCons/Tool/tex.xml index df7196e..b30b36d 100644 --- a/src/engine/SCons/Tool/tex.xml +++ b/src/engine/SCons/Tool/tex.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="tex"> <summary> XXX diff --git a/src/engine/SCons/Tool/tlib.xml b/src/engine/SCons/Tool/tlib.xml index 0351568..9415c7d 100644 --- a/src/engine/SCons/Tool/tlib.xml +++ b/src/engine/SCons/Tool/tlib.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="tlib"> <summary> XXX diff --git a/src/engine/SCons/Tool/yacc.xml b/src/engine/SCons/Tool/yacc.xml index 97bdf9b..48bb323 100644 --- a/src/engine/SCons/Tool/yacc.xml +++ b/src/engine/SCons/Tool/yacc.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="yacc"> <summary> XXX diff --git a/src/engine/SCons/Tool/zip.xml b/src/engine/SCons/Tool/zip.xml index 4e33c15..5e28bee 100644 --- a/src/engine/SCons/Tool/zip.xml +++ b/src/engine/SCons/Tool/zip.xml @@ -1,4 +1,9 @@ -<!-- __COPYRIGHT__ --> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> <tool name="zip"> <summary> XXX @@ -17,6 +22,12 @@ for a given target; each additional call adds to the list of entries that will be built into the archive. +Any source directories will +be scanned for changes to +any on-disk files, +regardless of whether or not +&scons; +knows about them from other Builder or function calls. <example> env.Zip('src.zip', 'src') @@ -67,11 +78,11 @@ module used by the internal Python function to control whether the zip archive is compressed or not. The default value is -<varname>zipfile.ZIP_DEFLATED</varname>, +<literal>zipfile.ZIP_DEFLATED</literal>, which creates a compressed zip archive. This value has no effect when using Python 1.5.2 or if the -<varname>zipfile</varname> +<literal>zipfile</literal> module is otherwise unavailable. </summary> </cvar> |