summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2024-11-16 22:26:32 (GMT)
committerGitHub <noreply@github.com>2024-11-16 22:26:32 (GMT)
commit630ee1c6e34272a69bff31cdc3d56e95e27b7c0d (patch)
tree89a24e053ac4aedb0ea736eb26cd0e04b49f138f
parentd1d5355b716644be649d99b16c6f2bf64e9f64e4 (diff)
parente73b7d350d1e0aa005bd72b44dc5b067e30dc58e (diff)
downloadSCons-630ee1c6e34272a69bff31cdc3d56e95e27b7c0d.zip
SCons-630ee1c6e34272a69bff31cdc3d56e95e27b7c0d.tar.gz
SCons-630ee1c6e34272a69bff31cdc3d56e95e27b7c0d.tar.bz2
Merge pull request #4649 from rico-chet/fix-languagetool-complaints
Fix English issues in the documentation
-rw-r--r--CHANGES.txt3
-rw-r--r--RELEASE.txt3
-rw-r--r--SCons/Action.xml4
-rw-r--r--SCons/Defaults.xml20
-rw-r--r--SCons/Environment.xml52
-rw-r--r--SCons/Script/Main.xml8
-rw-r--r--SCons/Script/SConscript.xml2
-rw-r--r--SCons/Subst.xml2
-rw-r--r--SCons/Tool/DCommon.xml2
-rw-r--r--SCons/Tool/Tool.xml4
-rw-r--r--SCons/Tool/c++.xml8
-rw-r--r--SCons/Tool/docbook/docbook.xml8
-rw-r--r--SCons/Tool/f03.xml4
-rw-r--r--SCons/Tool/f08.xml4
-rw-r--r--SCons/Tool/f77.xml4
-rw-r--r--SCons/Tool/f90.xml4
-rw-r--r--SCons/Tool/f95.xml4
-rw-r--r--SCons/Tool/fortran.xml2
-rw-r--r--SCons/Tool/gs.xml2
-rw-r--r--SCons/Tool/install.xml2
-rw-r--r--SCons/Tool/jar.xml2
-rw-r--r--SCons/Tool/javac.xml6
-rw-r--r--SCons/Tool/lex.xml4
-rw-r--r--SCons/Tool/link.xml4
-rw-r--r--SCons/Tool/msvc.xml4
-rw-r--r--SCons/Tool/msvs.xml12
-rw-r--r--SCons/Tool/ninja/ninja.xml6
-rw-r--r--SCons/Tool/packaging/packaging.xml8
-rw-r--r--SCons/Tool/qt3.xml2
-rw-r--r--SCons/Tool/swig.xml4
-rw-r--r--SCons/Tool/textfile.xml10
-rw-r--r--SCons/Tool/tlib.xml4
-rw-r--r--SCons/Tool/xgettext.xml6
-rw-r--r--SCons/Tool/zip.xml2
-rw-r--r--doc/generated/builders.gen601
-rw-r--r--doc/generated/examples/caching_ex-random_1.xml6
-rw-r--r--doc/generated/examples/commandline_PackageVariable_1.xml2
-rw-r--r--doc/generated/examples/troubleshoot_explain1_3.xml2
-rw-r--r--doc/generated/examples/troubleshoot_taskmastertrace_1.xml50
-rw-r--r--doc/generated/functions.gen238
-rw-r--r--doc/generated/tools.gen75
-rw-r--r--doc/generated/variables.gen140
-rw-r--r--doc/man/scons-time.xml12
-rw-r--r--doc/man/scons.xml108
-rw-r--r--doc/python10/summary.xml2
-rw-r--r--doc/user/add-method.xml4
-rw-r--r--doc/user/build-install.xml6
-rw-r--r--doc/user/builders-writing.xml16
-rw-r--r--doc/user/caching.xml10
-rw-r--r--doc/user/command-line.xml2
-rw-r--r--doc/user/depends.xml10
-rw-r--r--doc/user/environments.xml14
-rw-r--r--doc/user/external.xml4
-rw-r--r--doc/user/file-removal.xml4
-rw-r--r--doc/user/gettext.xml12
-rw-r--r--doc/user/hierarchy.xml6
-rw-r--r--doc/user/java.xml4
-rw-r--r--doc/user/less-simple.xml4
-rw-r--r--doc/user/make.xml4
-rw-r--r--doc/user/misc.xml2
-rw-r--r--doc/user/nodes.xml2
-rw-r--r--doc/user/output.xml2
-rw-r--r--doc/user/parseconfig.xml2
-rw-r--r--doc/user/parseflags.xml2
-rw-r--r--doc/user/scanners.xml4
-rw-r--r--doc/user/sconf.xml2
-rw-r--r--doc/user/separate.xml12
-rw-r--r--doc/user/sideeffect.xml8
-rw-r--r--doc/user/simple.xml2
-rw-r--r--doc/user/troubleshoot.xml14
-rw-r--r--doc/user/variants.xml2
71 files changed, 849 insertions, 757 deletions
diff --git a/CHANGES.txt b/CHANGES.txt
index 478b67d..9fa60af 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -90,6 +90,9 @@ RELEASE VERSION/DATE TO BE FILLED IN LATER
From Keith F Prussing:
- Added support for tracking beamer themes in the LaTeX scanner.
+ From rico-chet:
+ - Many grammatical and spelling fixes in the documentation.
+
From Mats Wichmann:
- PackageVariable now does what the documentation always said it does
if the variable is used on the command line with one of the enabling
diff --git a/RELEASE.txt b/RELEASE.txt
index ae1b90b..b12a538 100644
--- a/RELEASE.txt
+++ b/RELEASE.txt
@@ -172,6 +172,9 @@ DOCUMENTATION
- Clarify documentation of Repository() in manpage and user guide.
+- Many grammatical and spelling fixes in the documentation.
+
+
DEVELOPMENT
-----------
diff --git a/SCons/Action.xml b/SCons/Action.xml
index c71c305..906324c 100644
--- a/SCons/Action.xml
+++ b/SCons/Action.xml
@@ -59,9 +59,9 @@ greater than one, as that has a different meaning).
<para>
Action strings can be segmented by the
use of an AND operator, <literal>&amp;&amp;</literal>.
-In a segemented string, each segment is a separate
+In a segmented string, each segment is a separate
<quote>command line</quote>, these are run
-sequentially until one fails or the entire
+sequentially until one fails, or the entire
sequence has been executed. If an
action string is segmented, then the selected
behavior of &cv-IMPLICIT_COMMAND_DEPENDENCIES;
diff --git a/SCons/Defaults.xml b/SCons/Defaults.xml
index 933fe9d..4385390 100644
--- a/SCons/Defaults.xml
+++ b/SCons/Defaults.xml
@@ -147,7 +147,7 @@ and the second is the macro definition.
If the definition is not omitted or <literal>None</literal>,
the name and definition are combined into a single
<literal>name=definition</literal> item
-before the preending/appending.
+before the prepending/appending.
</para>
<example_commands>
@@ -261,7 +261,7 @@ to each directory in &cv-link-CPPPATH;.
The list of directories that the C preprocessor will search for include
directories. The C/C++ implicit dependency scanner will search these
directories for include files.
-In general it's not advised to put include directory directives
+In general, it's not advised to put include directory directives
directly into &cv-link-CCFLAGS; or &cv-link-CXXFLAGS;
as the result will be non-portable
and the directories will not be searched by the dependency scanner.
@@ -276,7 +276,7 @@ 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;
-to look-up a directory relative to the root of the source tree use
+to lookup a directory relative to the root of the source tree, use
the <literal>#</literal> prefix:
</para>
@@ -285,7 +285,7 @@ env = Environment(CPPPATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&f-link-Dir;
function:
</para>
@@ -548,7 +548,7 @@ directory names in &cv-LIBPATH; will be looked-up relative to the
directory of the SConscript file
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 lookup a directory relative to the root of the source tree, use
the <literal>#</literal> prefix:
</para>
@@ -557,7 +557,7 @@ env = Environment(LIBPATH='#/libs')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&f-link-Dir; function:
</para>
@@ -618,7 +618,7 @@ If &cv-link-LIBLITERALPREFIX; is set to a non-empty string,
then a string-valued &cv-LIBS; entry
that starts with &cv-link-LIBLITERALPREFIX;
will cause the rest of the entry
-to be searched for for unmodified,
+to be searched for unmodified,
but respecting normal library search paths
(this is an exception to the guideline above
about leaving off the prefix/suffix from the library name).
@@ -649,12 +649,12 @@ env.Append(LIBS=File('/tmp/mylib.so'))
<!-- is this actually true? -->
For each &Builder; call that causes linking with libraries,
&SCons; will add the libraries in the setting of &cv-LIBS;
-in effect at that moment to the dependecy graph
+in effect at that moment to the dependency graph
as dependencies of the target being generated.
</para>
<para>
-The library list will transformed to command line
+The library list will be transformed to command-line
arguments through the automatically-generated
&cv-link-_LIBFLAGS; &consvar;
which is constructed by
@@ -764,7 +764,7 @@ build phase begins, if has not already been done.
However, calling it explicitly provides the opportunity to
affect and examine its contents.
Instantiation occurs even if nothing in the build system
-appars to use it, due to internal uses.
+appears to use it, due to internal uses.
</para>
<para>
diff --git a/SCons/Environment.xml b/SCons/Environment.xml
index bc4c3b7..dafc649 100644
--- a/SCons/Environment.xml
+++ b/SCons/Environment.xml
@@ -513,7 +513,7 @@ env.Alias('update', ['file1', 'file2'], "update_database $SOURCES")
<para>
Marks each given
<parameter>target</parameter>
-so that it is always assumed to be out of date,
+so that it is always assumed to be out-of-date,
and will always be rebuilt if needed.
Note, however, that
&f-AlwaysBuild;
@@ -572,15 +572,15 @@ named <parameter>key</parameter>,
then <parameter>key</parameter> is simply
stored with a value of <parameter>val</parameter>.
Otherwise, <parameter>val</parameter> is
-combinined with the existing value,
+combined with the existing value,
possibly converting into an appropriate type
which can hold the expanded contents.
There are a few special cases to be aware of.
Normally, when two strings are combined,
the result is a new string containing their concatenation
(and you are responsible for supplying any needed separation);
-however, the contents of &cv-link-CPPDEFINES; will
-will be postprocessed by adding a prefix and/or suffix
+however, the contents of &cv-link-CPPDEFINES;
+will be post-processed by adding a prefix and/or suffix
to each entry when the command line is produced,
so &SCons; keeps them separate -
appending a string will result in a separate string entry,
@@ -696,7 +696,7 @@ scons: `.' is up to date.
<para>
<emphasis>Changed in version 4.5</emphasis>:
-clarifined the use of tuples vs. other types,
+clarified the use of tuples vs. other types,
handling is now consistent across the four functions.
</para>
@@ -723,7 +723,7 @@ See &cv-link-CPPDEFINES; for more details.
<para>
Appending a string <parameter>val</parameter>
-to a dictonary-typed &consvar; enters
+to a dictionary-typed &consvar; enters
<parameter>val</parameter> as the key in the dictionary,
and <literal>None</literal> as its value.
Using a tuple type to supply a key-value pair
@@ -1033,7 +1033,7 @@ either as separate arguments to the
&f-Clean;
method, or as a list.
&f-Clean;
-will also accept the return value of any of the &consenv;
+will also accept the return value of the &consenv;
Builder methods.
Examples:
</para>
@@ -1065,7 +1065,7 @@ Clean(['foo', 'bar'], 'something_else_to_clean')
In this example,
installing the project creates a subdirectory for the documentation.
This statement causes the subdirectory to be removed
-if the project is deinstalled.
+if the project is uninstalled.
</para>
<example_commands>
Clean(docdir, os.path.join(docdir, projectname))
@@ -1146,7 +1146,7 @@ This is useful for "one-off" builds
where a full Builder is not needed.
Since the anonymous Builder is never hooked
into the standard Builder framework,
-an Action must always be specfied.
+an Action must always be specified.
See the &f-link-Command; function description
for the calling syntax and details.
</para>
@@ -1339,7 +1339,7 @@ that specify a predefined decider function:
<term><literal>"content"</literal></term>
<listitem>
<para>
-Specifies that a target shall be considered out of date and rebuilt
+Specifies that a target shall be considered out-of-date and rebuilt
if the dependency's content has changed since the last time
the target was built,
as determined by performing a checksum
@@ -1361,7 +1361,7 @@ can still be used as a synonym, but is deprecated.
<term><literal>"content-timestamp"</literal></term>
<listitem>
<para>
-Specifies that a target shall be considered out of date and rebuilt
+Specifies that a target shall be considered out-of-date and rebuilt
if the dependency's content has changed since the last time
the target was built,
except that dependencies with a timestamp that matches
@@ -1398,7 +1398,7 @@ can still be used as a synonym, but is deprecated.
<term><literal>"timestamp-newer"</literal></term>
<listitem>
<para>
-Specifies that a target shall be considered out of date and rebuilt
+Specifies that a target shall be considered out-of-date and rebuilt
if the dependency's timestamp is newer than the target file's timestamp.
This is the behavior of the classic Make utility,
and
@@ -1412,7 +1412,7 @@ can be used a synonym for
<term><literal>"timestamp-match"</literal></term>
<listitem>
<para>
-Specifies that a target shall be considered out of date and rebuilt
+Specifies that a target shall be considered out-of-date and rebuilt
if the dependency's timestamp is different than the
timestamp recorded the last time the target was built.
This provides behavior very similar to the classic Make utility
@@ -1458,7 +1458,7 @@ The Node (file) which
should cause the
<parameter>target</parameter>
to be rebuilt
-if it has "changed" since the last tme
+if it has "changed" since the last time
<parameter>target</parameter>
was built.
</para>
@@ -1533,7 +1533,7 @@ otherwise
<emphasis>not</emphasis>
be rebuilt).
Note that the decision can be made
-using whatever criteria are appopriate.
+using whatever criteria are appropriate.
Ignoring some or all of the function arguments
is perfectly normal.
</para>
@@ -2033,7 +2033,7 @@ FindSourceFiles('src')
</example_commands>
<para>
-As you can see build support files (&SConstruct; in the above example)
+As you can see, build support files (&SConstruct; in the above example)
will also be returned by this function.
</para>
</summary>
@@ -2117,8 +2117,8 @@ or (most commonly) relative to the directory of the current
&f-Glob; matches both files stored on disk and Nodes
which &SCons; already knows about, even if any corresponding
file is not currently stored on disk.
-The evironment method form (&f-env-Glob;)
-performs string substition on
+The environment method form (&f-env-Glob;)
+performs string substitution on
<parameter>pattern</parameter>
and returns whatever matches the resulting expanded pattern.
The results are sorted, unlike for the similar &Python;
@@ -2209,7 +2209,7 @@ If the optional
<parameter>source</parameter>
argument evaluates true,
and the local directory is a variant directory,
-then &f-Glob; returnes Nodes from
+then &f-Glob; returns Nodes from
the corresponding source directory,
rather than the local directory.
<!-- XXX what about generated files that don't exist in src but will be sources? -->
@@ -2243,7 +2243,7 @@ directory.)
The optional
<parameter>exclude</parameter>
argument may be set to a pattern or a list of patterns
-descibing files or directories
+describing files or directories
to filter out of the match list.
Elements matching a least one specified pattern will be excluded.
These patterns use the same syntax as for
@@ -2448,7 +2448,7 @@ In case of duplication,
any &consvar; names that end in
<literal>PATH</literal>
keep the left-most value so the
-path searcb order is not altered.
+path search order is not altered.
All other &consvars; keep
the right-most value.
If <literal>unique</literal> is false,
@@ -2620,11 +2620,11 @@ the output produced by <parameter>command</parameter>
in order to distribute it to appropriate &consvars;.
&f-env-MergeFlags; uses a separate function to
do that processing -
-see &f-link-env-ParseFlags; for the details, including a
+see &f-link-env-ParseFlags; for the details, including
a table of options and corresponding &consvars;.
To provide alternative processing of the output of
<parameter>command</parameter>,
-you can suppply a custom
+you can supply a custom
<parameter>function</parameter>,
which must accept three arguments:
the &consenv; to modify,
@@ -2846,7 +2846,7 @@ See the manpage section "Construction Environments" for more details.
<summary>
<para>
Prepend values to &consvars; in the current &consenv;,
-Works like &f-link-env-Append; (see for details),
+works like &f-link-env-Append; (see for details),
except that values are added to the front,
rather than the end, of any existing value of the &consvar;
</para>
@@ -3225,7 +3225,7 @@ in a separate
<filename>.sconsign</filename>
file in each directory,
not in a single combined database file.
-This is a backwards-compatibility meaure to support
+This is a backwards-compatibility measure to support
what was the default behavior
prior to &SCons; 0.97 (i.e. before 2008).
Use of this mode is discouraged and may be
@@ -3602,7 +3602,7 @@ Returns a Node object representing the specified &Python;
Value Nodes can be used as dependencies of targets.
If the string representation of the Value Node
changes between &SCons; runs, it is considered
-out of date and any targets depending it will be rebuilt.
+out-of-date and any targets depending on it will be rebuilt.
Since Value Nodes have no filesystem representation,
timestamps are not used; the timestamp deciders
perform the same content-based up to date check.
diff --git a/SCons/Script/Main.xml b/SCons/Script/Main.xml
index 9dd9609..810e8aa 100644
--- a/SCons/Script/Main.xml
+++ b/SCons/Script/Main.xml
@@ -43,7 +43,7 @@ but with a few additional capabilities noted below.
See the
<ulink url="https://docs.python.org/3/library/optparse.html">
optparse documentation</ulink>
-for a thorough discussion of its option-processing capabities.
+for a thorough discussion of its option-processing capabilities.
All options added through &f-AddOption; are placed
in a special "Local Options" option group.
</para>
@@ -200,8 +200,8 @@ Future versions of &SCons; will likely forbid such usage.
</arguments>
<summary>
<para>
-Allows setting options for SCons debug options. Currently the only supported value is
- <emphasis>json</emphasis> which sets the path to the json file created when
+Allows setting options for SCons debug options. Currently, the only supported value is
+ <emphasis>json</emphasis> which sets the path to the JSON file created when
<literal>--debug=json</literal> is set.
</para>
<example_commands>
@@ -700,7 +700,7 @@ If the string contains the verbatim substring
it will be replaced with the Node.
Note that, for performance reasons, this is
<emphasis>not</emphasis>
-a regular SCons variable substition,
+a regular SCons variable substitution,
so you can not use other variables
or use curly braces.
The following example will print the name of
diff --git a/SCons/Script/SConscript.xml b/SCons/Script/SConscript.xml
index b64d9c3..7ae0159 100644
--- a/SCons/Script/SConscript.xml
+++ b/SCons/Script/SConscript.xml
@@ -364,7 +364,7 @@ Import("*")
Return to the calling SConscript, optionally
returning the values of variables named in
<varname>vars</varname>.
-Multiple strings contaning variable names may be passed to
+Multiple strings containing variable names may be passed to
&f-Return;. A string containing white space
is split into individual variable names.
Returns the value if one variable is specified,
diff --git a/SCons/Subst.xml b/SCons/Subst.xml
index 4ac4f7d..71aab2f 100644
--- a/SCons/Subst.xml
+++ b/SCons/Subst.xml
@@ -66,7 +66,7 @@ Example:
AllowSubstExceptions()
# Also allow a string containing a zero-division expansion
-# like '${1 / 0}' to evalute to ''.
+# like '${1 / 0}' to evaluate to ''.
AllowSubstExceptions(IndexError, NameError, ZeroDivisionError)
</example_commands>
</summary>
diff --git a/SCons/Tool/DCommon.xml b/SCons/Tool/DCommon.xml
index c46ed43..03a7096 100644
--- a/SCons/Tool/DCommon.xml
+++ b/SCons/Tool/DCommon.xml
@@ -286,7 +286,7 @@ DVERSUFFIX.
<summary>
<para>
The name of the compiler to use when compiling D source
-destined to be in a shared objects.
+destined to be in a shared object.
See also &cv-link-DC; for compiling to static objects.
</para>
</summary>
diff --git a/SCons/Tool/Tool.xml b/SCons/Tool/Tool.xml
index 5e996c7..fcd33fe 100644
--- a/SCons/Tool/Tool.xml
+++ b/SCons/Tool/Tool.xml
@@ -482,7 +482,7 @@ and
as C++ files,
and files with
<filename>.mm</filename>
-suffixes as Objective C++ files.
+suffixes as Objective-C++ files.
On case-sensitive systems (Linux, UNIX, and other POSIX-alikes),
SCons also treats
<filename>.C</filename>
@@ -567,7 +567,7 @@ When this &consvar; is defined, a versioned shared library
is created by the &b-link-SharedLibrary; builder. This activates the
&cv-link-_SHLIBVERSIONFLAGS; and thus modifies the &cv-link-SHLINKCOM; as
required, adds the version number to the library name, and creates the symlinks
-that are needed. &cv-link-SHLIBVERSION; versions should exist as alpha-numeric,
+that are needed. &cv-link-SHLIBVERSION; versions should exist as alphanumeric,
decimal-delimited values as defined by the regular expression "\w+[\.\w+]*".
Example &cv-link-SHLIBVERSION; values include '1', '1.2.3', and '1.2.gitaa412c8b'.
</para>
diff --git a/SCons/Tool/c++.xml b/SCons/Tool/c++.xml
index af1e9e1..4e08a3b 100644
--- a/SCons/Tool/c++.xml
+++ b/SCons/Tool/c++.xml
@@ -56,7 +56,7 @@ Sets construction variables for generic POSIX C++ compilers.
<summary>
<para>
The C++ compiler.
-See also &cv-link-SHCXX; for compiling to shared objects..
+See also &cv-link-SHCXX; for compiling to shared objects.
</para>
</summary>
</cvar>
@@ -68,7 +68,7 @@ The command line used to compile a C++ source file to an object file.
Any options specified in the &cv-link-CXXFLAGS; and
&cv-link-CPPFLAGS; construction variables
are included on this command line.
-See also &cv-link-SHCXXCOM; for compiling to shared objects..
+See also &cv-link-SHCXXCOM; for compiling to shared objects.
</para>
</summary>
</cvar>
@@ -79,7 +79,7 @@ See also &cv-link-SHCXXCOM; for compiling to shared objects..
If set, the string displayed when a C++ source file
is compiled to a (static) object file.
If not set, then &cv-link-CXXCOM; (the command line) is displayed.
-See also &cv-link-SHCXXCOMSTR; for compiling to shared objects..
+See also &cv-link-SHCXXCOMSTR; for compiling to shared objects.
</para>
<example_commands>
@@ -96,7 +96,7 @@ By default, this includes the value of &cv-link-CCFLAGS;,
so that setting &cv-CCFLAGS; affects both C and C++ compilation.
If you want to add C++-specific flags,
you must set or override the value of &cv-link-CXXFLAGS;.
-See also &cv-link-SHCXXFLAGS; for compiling to shared objects..
+See also &cv-link-SHCXXFLAGS; for compiling to shared objects.
</para>
</summary>
</cvar>
diff --git a/SCons/Tool/docbook/docbook.xml b/SCons/Tool/docbook/docbook.xml
index 79d2aea..464c1b2 100644
--- a/SCons/Tool/docbook/docbook.xml
+++ b/SCons/Tool/docbook/docbook.xml
@@ -286,7 +286,7 @@ if one of them is installed (<literal>fop</literal> gets checked first).
<cvar name="DOCBOOK_XSLTPROCFLAGS">
<summary>
<para>
-Additonal command-line flags for the external executable
+Additional command-line flags for the external executable
<literal>xsltproc</literal> (or <literal>saxon</literal>,
<literal>xalan</literal>).
</para>
@@ -296,7 +296,7 @@ Additonal command-line flags for the external executable
<cvar name="DOCBOOK_XMLLINTFLAGS">
<summary>
<para>
-Additonal command-line flags for the external executable
+Additional command-line flags for the external executable
<literal>xmllint</literal>.
</para>
</summary>
@@ -305,7 +305,7 @@ Additonal command-line flags for the external executable
<cvar name="DOCBOOK_FOPFLAGS">
<summary>
<para>
-Additonal command-line flags for the
+Additional command-line flags for the
PDF renderer <literal>fop</literal> or <literal>xep</literal>.
</para>
</summary>
@@ -314,7 +314,7 @@ PDF renderer <literal>fop</literal> or <literal>xep</literal>.
<cvar name="DOCBOOK_XSLTPROCPARAMS">
<summary>
<para>
-Additonal parameters that are not intended for the XSLT processor executable, but
+Additional parameters that are not intended for the XSLT processor executable, but
the XSL processing itself. By default, they get appended at the end of the command line
for <literal>saxon</literal> and <literal>saxon-xslt</literal>, respectively.
</para>
diff --git a/SCons/Tool/f03.xml b/SCons/Tool/f03.xml
index e5df9eb..3a0a8a2 100644
--- a/SCons/Tool/f03.xml
+++ b/SCons/Tool/f03.xml
@@ -154,7 +154,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F03PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F03PATH; if you need to define a specific
include path for Fortran 03 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -168,7 +168,7 @@ env = Environment(F03PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
diff --git a/SCons/Tool/f08.xml b/SCons/Tool/f08.xml
index e50f857..8fd0176 100644
--- a/SCons/Tool/f08.xml
+++ b/SCons/Tool/f08.xml
@@ -154,7 +154,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F08PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F08PATH; if you need to define a specific
include path for Fortran 08 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -168,7 +168,7 @@ env = Environment(F08PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
diff --git a/SCons/Tool/f77.xml b/SCons/Tool/f77.xml
index a98c110..e699298 100644
--- a/SCons/Tool/f77.xml
+++ b/SCons/Tool/f77.xml
@@ -169,7 +169,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F77PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F77PATH; if you need to define a specific
include path for Fortran 77 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -183,7 +183,7 @@ env = Environment(F77PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
diff --git a/SCons/Tool/f90.xml b/SCons/Tool/f90.xml
index 0a2f6a0..89c5ddc 100644
--- a/SCons/Tool/f90.xml
+++ b/SCons/Tool/f90.xml
@@ -154,7 +154,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F90PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F90PATH; if you need to define a specific
include path for Fortran 90 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -168,7 +168,7 @@ env = Environment(F90PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
diff --git a/SCons/Tool/f95.xml b/SCons/Tool/f95.xml
index 3e96484..5dd55d9 100644
--- a/SCons/Tool/f95.xml
+++ b/SCons/Tool/f95.xml
@@ -154,7 +154,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F95PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F95PATH; if you need to define a specific
include path for Fortran 95 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -168,7 +168,7 @@ env = Environment(F95PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
diff --git a/SCons/Tool/fortran.xml b/SCons/Tool/fortran.xml
index 944eb3e..2b62f05 100644
--- a/SCons/Tool/fortran.xml
+++ b/SCons/Tool/fortran.xml
@@ -239,7 +239,7 @@ non-portable and the directories will not be searched by the dependency
scanner. Note: directory names in FORTRANPATH 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 lookup a directory relative to the root of the source tree, use #:
</para>
<example_commands>
diff --git a/SCons/Tool/gs.xml b/SCons/Tool/gs.xml
index b984fd3..0feec0b 100644
--- a/SCons/Tool/gs.xml
+++ b/SCons/Tool/gs.xml
@@ -27,7 +27,7 @@ This file is processed by the bin/SConsDoc.py module.
<tool name="gs">
<summary>
<para>
-This Tool sets the required construction variables for working with
+This &f-Tool; sets the required construction variables for working with
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.
diff --git a/SCons/Tool/install.xml b/SCons/Tool/install.xml
index 3069cad..cdb044b 100644
--- a/SCons/Tool/install.xml
+++ b/SCons/Tool/install.xml
@@ -72,7 +72,7 @@ in this case.
If the <option>--install-sandbox</option> command line
option is given, the target directory will be prefixed
by the directory path specified.
-This is useful to test installs without installing to
+This is useful to test installation behavior without installing to
a "live" location in the system.
</para>
diff --git a/SCons/Tool/jar.xml b/SCons/Tool/jar.xml
index 011ce4e..ba8b2df 100644
--- a/SCons/Tool/jar.xml
+++ b/SCons/Tool/jar.xml
@@ -130,7 +130,7 @@ env = Environment(JARCOMSTR="JARchiving $SOURCES into $TARGET")
<summary>
<para>
General options passed to the Java archive tool.
-By default this is set to
+By default, this is set to
<option>cf</option>
to create the necessary
<command>jar</command>
diff --git a/SCons/Tool/javac.xml b/SCons/Tool/javac.xml
index d3be4f8..c43470c 100644
--- a/SCons/Tool/javac.xml
+++ b/SCons/Tool/javac.xml
@@ -109,8 +109,8 @@ env.Java(target='classes', source=['File1.java', 'File2.java'])
In this case, the user must specify the
<literal>LANG</literal>
environment variable to tell the compiler what encoding is used.
- For portibility, it's best if the encoding is hard-coded
- so that the compile will work if it is done on a system
+ For portability, it's best if the encoding is hard-coded,
+ so that the compilation works when run on a system
with a different encoding.
</para>
@@ -364,7 +364,7 @@ env = Environment(JAVACCOMSTR="Compiling class files $TARGETS from $SOURCES")
that &SCons; expects will be generated by the &javac; compiler.
Setting &cv-JAVAVERSION; to a version greater than
<literal>1.4</literal> makes &SCons; realize that a build
- with such a compiler is actually up to date.
+ with such a compiler is actually up-to-date.
The default is <literal>1.4</literal>.
</para>
<para>
diff --git a/SCons/Tool/lex.xml b/SCons/Tool/lex.xml
index e1e1190..028072b 100644
--- a/SCons/Tool/lex.xml
+++ b/SCons/Tool/lex.xml
@@ -27,7 +27,7 @@ This file is processed by the bin/SConsDoc.py module.
<tool name="lex">
<summary>
<para>
-Sets construction variables for the &lex; lexical analyser.
+Sets construction variables for the &lex; lexical analyzer.
</para>
</summary>
<sets>
@@ -123,7 +123,7 @@ command-line option. Use this in preference to including
<cvar name="LEXUNISTD">
<summary>
<para>
-Used only on windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'.
+Used only in Windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'.
</para>
</summary>
</cvar>
diff --git a/SCons/Tool/link.xml b/SCons/Tool/link.xml
index 4bf7969..63d499c 100644
--- a/SCons/Tool/link.xml
+++ b/SCons/Tool/link.xml
@@ -66,7 +66,7 @@ based on the types of source files.
<summary>
<para>
This construction variable automatically introduces &cv-link-_LDMODULEVERSIONFLAGS;
-if &cv-link-LDMODULEVERSION; is set. Othervise it evaluates to an empty string.
+if &cv-link-LDMODULEVERSION; is set. Otherwise, it evaluates to an empty string.
</para>
</summary>
</cvar>
@@ -75,7 +75,7 @@ if &cv-link-LDMODULEVERSION; is set. Othervise it evaluates to an empty string.
<summary>
<para>
This construction variable automatically introduces &cv-link-_SHLIBVERSIONFLAGS;
-if &cv-link-SHLIBVERSION; is set. Othervise it evaluates to an empty string.
+if &cv-link-SHLIBVERSION; is set. Otherwise, it evaluates to an empty string.
</para>
</summary>
</cvar>
diff --git a/SCons/Tool/msvc.xml b/SCons/Tool/msvc.xml
index 97edb2c..c6fa977 100644
--- a/SCons/Tool/msvc.xml
+++ b/SCons/Tool/msvc.xml
@@ -298,7 +298,7 @@ only if the &cv-link-PDB; &consvar; is set.
<para>
This variable specifies how much of a source file is precompiled. This
variable is ignored by tools other than &MSVC;, or when
-the PCH variable is not being used. When this variable is define it
+the PCH variable is not being used. When this variable is defined, it
must be a string that is the name of the header that
is included at the end of the precompiled portion of the source files, or
the empty string if the "#pragma hrdstop" construct is being used:
@@ -621,7 +621,7 @@ Visual Studio </literallayout></entry>
It is only necessary to specify the <literal>Exp</literal>
suffix to select the express edition when both express and
non-express editions of the same product are installed
- simulaneously. The <literal>Exp</literal> suffix is unnecessary,
+ simultaneously. The <literal>Exp</literal> suffix is unnecessary,
but accepted, when only the express edition is installed.
</para></listitem>
</itemizedlist>
diff --git a/SCons/Tool/msvs.xml b/SCons/Tool/msvs.xml
index ad3a756..88aa854 100644
--- a/SCons/Tool/msvs.xml
+++ b/SCons/Tool/msvs.xml
@@ -279,7 +279,7 @@ This file is processed by the bin/SConsDoc.py module.
"build" from the Visual Studio interface) you lose the direct
control of target selection and command-line options you would
have if launching the build directly from &SCons;,
- because these will be hardcoded in the project file to the
+ because these will be hard-coded in the project file to the
values specified in the &b-MSVSProject; call.
You can regain some of this control by defining multiple variants,
using multiple &b-MSVSProject; calls to arrange different build
@@ -292,7 +292,7 @@ This file is processed by the bin/SConsDoc.py module.
it is important not to set Visual Studio to do parallel builds,
as it will then launch the separate project builds in parallel,
and &SCons; does not work well if called that way.
- Instead you can set up the &SCons; build for parallel building -
+ Instead, you can set up the &SCons; build for parallel building -
see the &f-link-SetOption; function for how to do this with
<parameter>num_jobs</parameter>.
</para>
@@ -438,7 +438,7 @@ V10DebugSettings = {
}
#
-# 3. Select the dictionary you want depending on the version of visual Studio
+# 3. Select the dictionary you want depending on the version of Visual Studio
# Files you want to generate.
#
if not env.GetOption('userfile'):
@@ -552,7 +552,7 @@ env.MSVSProject(
Under certain circumstances, solution file names or
solution file nodes may be present in the
<parameter>projects</parameter> argument list.
- When solution file names or nodes are present in the
+ When solution file names or nodes are present in the
<parameter>projects</parameter> argument list, the generated
solution file may contain erroneous Project records resulting
in VS IDE error messages when opening the generated solution
@@ -747,7 +747,7 @@ env.MSVSSolution(
<literal>SccProjectFilePathRelativizedFromConnection[i]</literal>
(where [i] ranges from 0 to the number of projects in the solution)
attributes of the <literal>GlobalSection(SourceCodeControl)</literal>
- section of the Microsoft Visual Studio solution file. Similarly
+ section of the Microsoft Visual Studio solution file. Similarly,
the relative solution file path is placed as the values of the
<literal>SccLocalPath[i]</literal> (where [i] ranges from 0
to the number of projects in the solution) attributes of the
@@ -803,7 +803,7 @@ env.MSVSSolution(
and &cv-MSVC_VERSION; is not,
&cv-MSVC_VERSION; will be initialized to the value
of &cv-MSVS_VERSION;.
- An error is raised if If both are set and have different values,
+ An error is raised if both are set and have different values.
</para>
</summary>
</cvar>
diff --git a/SCons/Tool/ninja/ninja.xml b/SCons/Tool/ninja/ninja.xml
index 3919194..f89687e 100644
--- a/SCons/Tool/ninja/ninja.xml
+++ b/SCons/Tool/ninja/ninja.xml
@@ -339,7 +339,7 @@ python -m pip install ninja
<cvar name="NINJA_FORCE_SCONS_BUILD">
<summary>
<para>
- If true, causes the build nodes to callback to scons instead of using
+ If true, causes the build nodes to call back to scons instead of using
&ninja; to build them. This is intended to be passed to the environment on the builder invocation.
It is useful if you have a build node which does something which is not easily translated into &ninja;.
</para>
@@ -350,7 +350,7 @@ python -m pip install ninja
<summary>
<para>
Internal value used to specify the function to call with argument env to generate the list of files
- which if changed would require the &ninja; build file to be regenerated.
+ which, if changed, would require the &ninja; build file to be regenerated.
</para>
</summary>
</cvar>
@@ -358,7 +358,7 @@ python -m pip install ninja
<cvar name="NINJA_SCONS_DAEMON_KEEP_ALIVE">
<summary>
<para>
- The number of seconds for the SCons deamon launched by ninja to stay alive.
+ The number of seconds for the SCons daemon launched by ninja to stay alive.
(Default: 180000)
</para>
</summary>
diff --git a/SCons/Tool/packaging/packaging.xml b/SCons/Tool/packaging/packaging.xml
index 62ba558..6f1a8d8 100644
--- a/SCons/Tool/packaging/packaging.xml
+++ b/SCons/Tool/packaging/packaging.xml
@@ -55,7 +55,7 @@ env = Environment(tools=['default', 'packaging'])
<para>
&SCons; can build packages in a number of well known packaging formats.
The target package type may be selected with the
-the &cv-link-PACKAGETYPE; construction variable
+&cv-link-PACKAGETYPE; construction variable
or the <option>--package-type</option> command line option.
The package type may be a list, in which case &SCons; will attempt
to build packages for each type in the list. Example:
@@ -73,7 +73,7 @@ The currently supported packagers are:
<tgroup cols="2">
<tbody>
<row><entry><literal>msi</literal></entry><entry>Microsoft Installer package</entry></row>
-<row><entry><literal>rpm</literal></entry><entry>RPM Package Manger package</entry></row>
+<row><entry><literal>rpm</literal></entry><entry>RPM Package Manager package</entry></row>
<row><entry><literal>ipkg</literal></entry><entry>Itsy Package Management package</entry></row>
<row><entry><literal>tarbz2</literal></entry><entry>bzip2-compressed tar file</entry></row>
<row><entry><literal>targz</literal></entry><entry>gzip-compressed tar file</entry></row>
@@ -262,7 +262,7 @@ placed if applicable. The default value is <quote>&cv-NAME;-&cv-VERSION;</quote
<summary>
<para>
Selects the package type to build when using the &b-link-Package;
-builder. May be a string or list of strings. See the docuentation
+builder. It may be a string or list of strings. See the documentation
for the builder for the currently supported types.
</para>
@@ -541,7 +541,7 @@ field in the RPM
<cvar name="X_RPM_EXTRADEFS">
<summary>
<para>
-A list used to supply extra defintions or flags
+A list used to supply extra definitions or flags
to be added to the RPM <filename>.spec</filename> file.
Each item is added as-is with a carriage return appended.
This is useful if some specific RPM feature not otherwise
diff --git a/SCons/Tool/qt3.xml b/SCons/Tool/qt3.xml
index a2762f7..4c75a88 100644
--- a/SCons/Tool/qt3.xml
+++ b/SCons/Tool/qt3.xml
@@ -74,7 +74,7 @@ The &t-qt3; tool supports the following operations:
<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
+the same basename as your implementation file and must stay in the same
directory. It must have one of the suffixes
<filename>.h</filename>,
<filename>.hpp</filename>,
diff --git a/SCons/Tool/swig.xml b/SCons/Tool/swig.xml
index 2d35504..14919ef 100644
--- a/SCons/Tool/swig.xml
+++ b/SCons/Tool/swig.xml
@@ -208,7 +208,7 @@ 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 lookup a directory relative to the root of the source tree, use
a top-relative path (<literal>#</literal>):
</para>
@@ -217,7 +217,7 @@ env = Environment(SWIGPATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
diff --git a/SCons/Tool/textfile.xml b/SCons/Tool/textfile.xml
index 895fbef..c16b3d0 100644
--- a/SCons/Tool/textfile.xml
+++ b/SCons/Tool/textfile.xml
@@ -68,7 +68,7 @@ and &cv-link-TEXTFILESUFFIX; &consvars;
are automatically added to the target if they are not already present.
</para>
<para>
-By default the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
+By default, the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
Examples:
</para>
@@ -82,7 +82,7 @@ env.Textfile(target='bar', source=['lalala', 'tanteratei'], LINESEPARATOR='|*')
# nested lists are flattened automatically
env.Textfile(target='blob', source=['lalala', ['Goethe', 42, 'Schiller'], 'tanteratei'])
-# files may be used as input by wraping them in File()
+# files may be used as input by wrapping them in File()
env.Textfile(
target='concat', # concatenate files with a marker between
source=[File('concat1'), File('concat2')],
@@ -131,7 +131,7 @@ are flattened. See also &b-link-Textfile;.
</para>
<para>
-By default the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
+By default, the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
Examples:
</para>
@@ -154,7 +154,7 @@ it may be either a Python dictionary or a sequence of
If it is a dictionary it is converted into a list of tuples
with unspecified order,
so if one key is a prefix of another key
-or if one substitution could be further expanded by another subsitition,
+or if one substitution could be further expanded by another substitution,
it is unpredictable whether the expansion will occur.
</para>
@@ -185,7 +185,7 @@ env.Substfile('foo.in', SUBST_DICT=bad_foo)
good_foo = [('$foobar', '$foobar'), ('$foo', '$foo')]
env.Substfile('foo.in', SUBST_DICT=good_foo)
-# UNPREDICTABLE - one substitution could be futher expanded
+# UNPREDICTABLE - one substitution could be further expanded
bad_bar = {'@bar@': '@soap@', '@soap@': 'lye'}
env.Substfile('bar.in', SUBST_DICT=bad_bar)
diff --git a/SCons/Tool/tlib.xml b/SCons/Tool/tlib.xml
index 7274890..1fb34ef 100644
--- a/SCons/Tool/tlib.xml
+++ b/SCons/Tool/tlib.xml
@@ -27,8 +27,8 @@ This file is processed by the bin/SConsDoc.py module.
<tool name="tlib">
<summary>
<para>
-Sets construction variables for the Borlan
-<application>tib</application> library archiver.
+Sets construction variables for the Borland
+<application>tlib</application> library archiver.
</para>
</summary>
<sets>
diff --git a/SCons/Tool/xgettext.xml b/SCons/Tool/xgettext.xml
index 10bec3a..940e24a 100644
--- a/SCons/Tool/xgettext.xml
+++ b/SCons/Tool/xgettext.xml
@@ -311,7 +311,7 @@ See also &t-link-xgettext; tool and &b-link-POTUpdate; builder.
<summary>
<para>
This flag is used to add single search path to
-<command>xgettext(1)</command>'s commandline (default:
+<command>xgettext(1)</command>'s command line (default:
<literal>'-D'</literal>).
</para>
</summary>
@@ -329,7 +329,7 @@ This flag is used to add single search path to
<summary>
<para>
This flag is used to add single &cv-link-XGETTEXTFROM; file to
-<command>xgettext(1)</command>'s commandline (default:
+<command>xgettext(1)</command>'s command line (default:
<literal>'-f'</literal>).
</para>
</summary>
@@ -355,7 +355,7 @@ form source and target (default: <literal>'${TARGET.filebase}'</literal>).
<cvar name="_XGETTEXTFROMFLAGS">
<summary>
<para>
-Internal "macro". Genrates list of <literal>-D&lt;dir&gt;</literal> flags
+Internal "macro". Generates list of <literal>-D&lt;dir&gt;</literal> flags
from the &cv-link-XGETTEXTPATH; list.
</para>
</summary>
diff --git a/SCons/Tool/zip.xml b/SCons/Tool/zip.xml
index 85fe19b..9458a12 100644
--- a/SCons/Tool/zip.xml
+++ b/SCons/Tool/zip.xml
@@ -149,7 +149,7 @@ The suffix used for zip file names.
<para>
An optional zip root directory (default empty). The filenames stored
in the zip file will be relative to this directory, if given.
-Otherwise the filenames are relative to the current directory of the
+Otherwise, the filenames are relative to the current directory of the
command.
For instance:
</para>
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen
index d0ee3dd..cfcb361 100644
--- a/doc/generated/builders.gen
+++ b/doc/generated/builders.gen
@@ -47,7 +47,7 @@ This is useful for "one-off" builds
where a full Builder is not needed.
Since the anonymous Builder is never hooked
into the standard Builder framework,
-an Action must always be specfied.
+an Action must always be specified.
See the &f-link-Command; function description
for the calling syntax and details.
</para>
@@ -474,7 +474,7 @@ in this case.
If the <option>--install-sandbox</option> command line
option is given, the target directory will be prefixed
by the directory path specified.
-This is useful to test installs without installing to
+This is useful to test installation behavior without installing to
a "live" location in the system.
</para>
@@ -642,8 +642,8 @@ env.Java(target='classes', source=['File1.java', 'File2.java'])
In this case, the user must specify the
<literal>LANG</literal>
environment variable to tell the compiler what encoding is used.
- For portibility, it's best if the encoding is hard-coded
- so that the compile will work if it is done on a system
+ For portability, it's best if the encoding is hard-coded,
+ so that the compilation works when run on a system
with a different encoding.
</para>
@@ -787,8 +787,12 @@ env.Moc('foo.cpp') # generates foo.moc
<term><function>MOFiles</function>()</term>
<term><replaceable>env</replaceable>.<methodname>MOFiles</methodname>()</term>
<listitem><para>
-This builder belongs to &t-link-msgfmt; tool. The builder compiles
+This builder is set up by the &t-link-msgfmt; tool.
+The builder compiles
<literal>PO</literal> files to <literal>MO</literal> files.
+&b-MOFiles; is a single-source builder.
+The <parameter>source</parameter> parameter
+can also be omitted if &cv-link-LINGUAS_FILE; is set.
</para>
<para>
@@ -796,19 +800,17 @@ This builder belongs to &t-link-msgfmt; tool. The builder compiles
Create <filename>pl.mo</filename> and <filename>en.mo</filename> by compiling
<filename>pl.po</filename> and <filename>en.po</filename>:
</para>
-<example_commands>
- # ...
- env.MOFiles(['pl', 'en'])
-</example_commands>
+<programlisting language="python">
+env.MOFiles(['pl', 'en'])
+</programlisting>
<para>
<emphasis>Example 2</emphasis>.
Compile files for languages defined in <filename>LINGUAS</filename> file:
</para>
-<example_commands>
- # ...
- env.MOFiles(LINGUAS_FILE = 1)
-</example_commands>
+<programlisting language="python">
+env.MOFiles(LINGUAS_FILE=True)
+</programlisting>
<para>
<emphasis>Example 3</emphasis>.
@@ -816,21 +818,19 @@ Create <filename>pl.mo</filename> and <filename>en.mo</filename> by compiling
<filename>pl.po</filename> and <filename>en.po</filename> plus files for
languages defined in <filename>LINGUAS</filename> file:
</para>
-<example_commands>
- # ...
- env.MOFiles(['pl', 'en'], LINGUAS_FILE = 1)
-</example_commands>
+<programlisting language="python">
+env.MOFiles(['pl', 'en'], LINGUAS_FILE=True)
+</programlisting>
<para>
<emphasis>Example 4</emphasis>.
Compile files for languages defined in <filename>LINGUAS</filename> file
(another version):
</para>
-<example_commands>
- # ...
- env['LINGUAS_FILE'] = 1
- env.MOFiles()
-</example_commands>
+<programlisting language="python">
+env['LINGUAS_FILE'] = True
+env.MOFiles()
+</programlisting>
</listitem>
</varlistentry>
<varlistentry id="b-MSVSProject">
@@ -1075,7 +1075,7 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
"build" from the Visual Studio interface) you lose the direct
control of target selection and command-line options you would
have if launching the build directly from &SCons;,
- because these will be hardcoded in the project file to the
+ because these will be hard-coded in the project file to the
values specified in the &b-MSVSProject; call.
You can regain some of this control by defining multiple variants,
using multiple &b-MSVSProject; calls to arrange different build
@@ -1088,7 +1088,7 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
it is important not to set Visual Studio to do parallel builds,
as it will then launch the separate project builds in parallel,
and &SCons; does not work well if called that way.
- Instead you can set up the &SCons; build for parallel building -
+ Instead, you can set up the &SCons; build for parallel building -
see the &f-link-SetOption; function for how to do this with
<parameter>num_jobs</parameter>.
</para>
@@ -1234,7 +1234,7 @@ V10DebugSettings = {
}
#
-# 3. Select the dictionary you want depending on the version of visual Studio
+# 3. Select the dictionary you want depending on the version of Visual Studio
# Files you want to generate.
#
if not env.GetOption('userfile'):
@@ -1337,6 +1337,74 @@ env.MSVSProject(
</listitem>
</varlistentry>
</variablelist>
+ <para>
+ In addition to the mandatory arguments above, the following optional
+ values may be specified as keyword arguments:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>auto_filter_projects</parameter></term>
+ <listitem>
+ <para>
+ Under certain circumstances, solution file names or
+ solution file nodes may be present in the
+ <parameter>projects</parameter> argument list.
+ When solution file names or nodes are present in the
+ <parameter>projects</parameter> argument list, the generated
+ solution file may contain erroneous Project records resulting
+ in VS IDE error messages when opening the generated solution
+ file.
+ By default, an exception is raised when a solution file
+ name or solution file node is detected in the
+ <parameter>projects</parameter> argument list.
+ </para>
+ <para>
+ The accepted values for <parameter>auto_filter_projects</parameter>
+ are:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>None</parameter></term>
+ <listitem>
+ <para>
+ An exception is raised when a solution file name or solution
+ file node is detected in the <parameter>projects</parameter>
+ argument list.
+ </para>
+ <para>
+ <parameter>None</parameter> is the default value.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>True or evaluates True</parameter></term>
+ <listitem>
+ <para>
+ Automatically remove solution file names and solution file
+ nodes from the <parameter>projects</parameter> argument list.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>False or evaluates False</parameter></term>
+ <listitem>
+ <para>
+ Leave the solution file names and solution file nodes
+ in the <parameter>projects</parameter> argument list.
+ An exception is not raised.
+ </para>
+ <para>
+ When opening the generated solution file with the VS IDE,
+ the VS IDE will likely report that there are erroneous
+ Project records that are not supported or that need to be
+ modified.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<para>Example Usage:</para>
<example_commands>
env.MSVSSolution(
@@ -1442,7 +1510,7 @@ env = Environment(tools=['default', 'packaging'])
<para>
&SCons; can build packages in a number of well known packaging formats.
The target package type may be selected with the
-the &cv-link-PACKAGETYPE; construction variable
+&cv-link-PACKAGETYPE; construction variable
or the <option>--package-type</option> command line option.
The package type may be a list, in which case &SCons; will attempt
to build packages for each type in the list. Example:
@@ -1460,7 +1528,7 @@ The currently supported packagers are:
<tgroup cols="2">
<tbody>
<row><entry><literal>msi</literal></entry><entry>Microsoft Installer package</entry></row>
-<row><entry><literal>rpm</literal></entry><entry>RPM Package Manger package</entry></row>
+<row><entry><literal>rpm</literal></entry><entry>RPM Package Manager package</entry></row>
<row><entry><literal>ipkg</literal></entry><entry>Itsy Package Management package</entry></row>
<row><entry><literal>tarbz2</literal></entry><entry>bzip2-compressed tar file</entry></row>
<row><entry><literal>targz</literal></entry><entry>gzip-compressed tar file</entry></row>
@@ -1606,41 +1674,48 @@ or
The suffix specified by the &cv-link-PDFSUFFIX; construction variable
(<filename>.pdf</filename> by default)
is added automatically to the target
-if it is not already present. Example:
+if it is not already present.
+&b-PDF; is a single-source builder.
+Example:
</para>
-<example_commands>
+<programlisting language="python">
# builds from aaa.tex
env.PDF(target = 'aaa.pdf', source = 'aaa.tex')
# builds bbb.pdf from bbb.dvi
env.PDF(target = 'bbb', source = 'bbb.dvi')
-</example_commands>
+</programlisting>
</listitem>
</varlistentry>
<varlistentry id="b-POInit">
<term><function>POInit</function>()</term>
<term><replaceable>env</replaceable>.<methodname>POInit</methodname>()</term>
<listitem><para>
-This builder belongs to &t-link-msginit; tool. The builder initializes missing
-<literal>PO</literal> file(s) if &cv-link-POAUTOINIT; is set. If
-&cv-link-POAUTOINIT; is not set (default), &b-POInit; prints instruction for
-user (that is supposed to be a translator), telling how the
-<literal>PO</literal> file should be initialized. In normal projects
+This builder is set up by the &t-link-msginit; tool.
+The builder initializes missing
+<literal>PO</literal> file(s) if &cv-link-POAUTOINIT; is set.
+If &cv-link-POAUTOINIT; is not set (the default),
+&b-POInit; prints instruction for the user (such as a translator),
+telling how the <literal>PO</literal> file should be initialized.
+In normal projects
<emphasis>you should not use &b-POInit; and use &b-link-POUpdate;
instead</emphasis>. &b-link-POUpdate; chooses intelligently between
<command>msgmerge(1)</command> and <command>msginit(1)</command>. &b-POInit;
always uses <command>msginit(1)</command> and should be regarded as builder for
special purposes or for temporary use (e.g. for quick, one time initialization
of a bunch of <literal>PO</literal> files) or for tests.
+&b-POInit; is a single-source builder.
+The <parameter>source</parameter> parameter
+can also be omitted if &cv-link-LINGUAS_FILE; is set.
</para>
<para>
Target nodes defined through &b-POInit; are not built by default (they're
<literal>Ignore</literal>d from <literal>'.'</literal> node) but are added to
-special <literal>Alias</literal> (<literal>'po-create'</literal> by default).
+special &f-link-Alias; (<literal>'po-create'</literal> by default).
The alias name may be changed through the &cv-link-POCREATE_ALIAS;
-construction variable. All <literal>PO</literal> files defined through
-&b-POInit; may be easily initialized by <command>scons po-create</command>.
+&consvar;. All <literal>PO</literal> files defined through
+&b-POInit; may be easily initialized by <userinput>scons po-create</userinput>.
</para>
<para>
@@ -1648,31 +1723,27 @@ construction variable. All <literal>PO</literal> files defined through
Initialize <filename>en.po</filename> and <filename>pl.po</filename> from
<filename>messages.pot</filename>:
</para>
-<example_commands>
- # ...
- env.POInit(['en', 'pl']) # messages.pot --&gt; [en.po, pl.po]
-</example_commands>
+<programlisting language="python">
+env.POInit(['en', 'pl']) # messages.pot --&gt; [en.po, pl.po]
+</programlisting>
<para>
<emphasis>Example 2</emphasis>.
Initialize <filename>en.po</filename> and <filename>pl.po</filename> from
<filename>foo.pot</filename>:
</para>
-<example_commands>
- # ...
- env.POInit(['en', 'pl'], ['foo']) # foo.pot --&gt; [en.po, pl.po]
-</example_commands>
+<programlisting language="python">
+env.POInit(['en', 'pl'], ['foo']) # foo.pot --&gt; [en.po, pl.po]
+</programlisting>
<para>
<emphasis>Example 3</emphasis>.
Initialize <filename>en.po</filename> and <filename>pl.po</filename> from
-<filename>foo.pot</filename> but using &cv-link-POTDOMAIN; construction
-variable:
+<filename>foo.pot</filename> but using the &cv-link-POTDOMAIN; &consvar;:
</para>
-<example_commands>
- # ...
- env.POInit(['en', 'pl'], POTDOMAIN='foo') # foo.pot --&gt; [en.po, pl.po]
-</example_commands>
+<programlisting language="python">
+env.POInit(['en', 'pl'], POTDOMAIN='foo') # foo.pot --&gt; [en.po, pl.po]
+</programlisting>
<para>
<emphasis>Example 4</emphasis>.
@@ -1680,10 +1751,9 @@ Initialize <literal>PO</literal> files for languages defined in
<filename>LINGUAS</filename> file. The files will be initialized from template
<filename>messages.pot</filename>:
</para>
-<example_commands>
- # ...
- env.POInit(LINGUAS_FILE = 1) # needs 'LINGUAS' file
-</example_commands>
+<programlisting language="python">
+env.POInit(LINGUAS_FILE=True) # needs 'LINGUAS' file
+</programlisting>
<para>
<emphasis>Example 5</emphasis>.
@@ -1692,30 +1762,27 @@ Initialize <filename>en.po</filename> and <filename>pl.pl</filename>
<filename>LINGUAS</filename> file. The files will be initialized from template
<filename>messages.pot</filename>:
</para>
-<example_commands>
- # ...
- env.POInit(['en', 'pl'], LINGUAS_FILE = 1)
-</example_commands>
+<programlisting language="python">
+env.POInit(['en', 'pl'], LINGUAS_FILE=True)
+</programlisting>
<para>
<emphasis>Example 6</emphasis>.
You may preconfigure your environment first, and then initialize
<literal>PO</literal> files:
</para>
-<example_commands>
- # ...
- env['POAUTOINIT'] = 1
- env['LINGUAS_FILE'] = 1
- env['POTDOMAIN'] = 'foo'
- env.POInit()
-</example_commands>
+<programlisting language="python">
+env['POAUTOINIT'] = True
+env['LINGUAS_FILE'] = True
+env['POTDOMAIN'] = 'foo'
+env.POInit()
+</programlisting>
<para>
which has same efect as:
</para>
-<example_commands>
- # ...
- env.POInit(POAUTOINIT = 1, LINGUAS_FILE = 1, POTDOMAIN = 'foo')
-</example_commands>
+<programlisting language="python">
+env.POInit(POAUTOINIT=True, LINGUAS_FILE=True, POTDOMAIN='foo')
+</programlisting>
</listitem>
</varlistentry>
<varlistentry id="b-PostScript">
@@ -1731,30 +1798,35 @@ or
The suffix specified by the &cv-link-PSSUFFIX; construction variable
(<filename>.ps</filename> by default)
is added automatically to the target
-if it is not already present. Example:
+if it is not already present.
+&b-PostScript; is a single-source builder.
+Example:
</para>
-<example_commands>
+<programlisting language="python">
# builds from aaa.tex
env.PostScript(target = 'aaa.ps', source = 'aaa.tex')
# builds bbb.ps from bbb.dvi
env.PostScript(target = 'bbb', source = 'bbb.dvi')
-</example_commands>
+</programlisting>
</listitem>
</varlistentry>
<varlistentry id="b-POTUpdate">
<term><function>POTUpdate</function>()</term>
<term><replaceable>env</replaceable>.<methodname>POTUpdate</methodname>()</term>
<listitem><para>
-The builder belongs to &t-link-xgettext; tool. The builder updates target
-<literal>POT</literal> file if exists or creates one if it doesn't. The node is
-not built by default (i.e. it is <literal>Ignore</literal>d from
-<literal>'.'</literal>), but only on demand (i.e. when given
-<literal>POT</literal> file is required or when special alias is invoked). This
-builder adds its targe node (<filename>messages.pot</filename>, say) to a
+The builder is set up by the &t-link-xgettext; tool,
+part of the &t-link-gettext; toolset.
+The builder updates the target
+<literal>POT</literal> file if exists or creates it if it doesn't.
+The target node is <emphasis>not</emphasis>
+selected for building by default (e.g. <userinput>scons .</userinput>),
+but only on demand (i.e. when the given
+<literal>POT</literal> file is required or when special alias is invoked).
+This builder adds its target node (<filename>messages.pot</filename>, say) to a
special alias (<literal>pot-update</literal> by default, see
&cv-link-POTUPDATE_ALIAS;) so you can update/create them easily with
-<command>scons pot-update</command>. The file is not written until there is no
+<userinput>scons pot-update</userinput>. The file is not written until there is no
real change in internationalized messages (or in comments that enter
<literal>POT</literal> file).
</para>
@@ -1774,86 +1846,87 @@ not.</para></note>
Let's create <filename>po/</filename> directory and place following
<filename>SConstruct</filename> script there:
</para>
-<example_commands>
- # SConstruct in 'po/' subdir
- env = Environment( tools = ['default', 'xgettext'] )
- env.POTUpdate(['foo'], ['../a.cpp', '../b.cpp'])
- env.POTUpdate(['bar'], ['../c.cpp', '../d.cpp'])
-</example_commands>
+<programlisting language="python">
+# SConstruct in 'po/' subdir
+env = Environment(tools=['default', 'xgettext'])
+env.POTUpdate(['foo'], ['../a.cpp', '../b.cpp'])
+env.POTUpdate(['bar'], ['../c.cpp', '../d.cpp'])
+</programlisting>
<para>
Then invoke scons few times:
</para>
-<example_commands>
- user@host:$ scons # Does not create foo.pot nor bar.pot
- user@host:$ scons foo.pot # Updates or creates foo.pot
- user@host:$ scons pot-update # Updates or creates foo.pot and bar.pot
- user@host:$ scons -c # Does not clean foo.pot nor bar.pot.
-</example_commands>
+<screen>
+$ scons # Does not create foo.pot nor bar.pot
+$ scons foo.pot # Updates or creates foo.pot
+$ scons pot-update # Updates or creates foo.pot and bar.pot
+$ scons -c # Does not clean foo.pot nor bar.pot.
+</screen>
<para>
the results shall be as the comments above say.
</para>
<para>
<emphasis>Example 2.</emphasis>
-The &b-POTUpdate; builder may be used with no target specified, in which
-case default target <filename>messages.pot</filename> will be used. The
-default target may also be overridden by setting &cv-link-POTDOMAIN; construction
-variable or providing it as an override to &b-POTUpdate; builder:
+The <parameter>target</parameter> argument can be omitted, in which
+case the default target name <filename>messages.pot</filename> is used.
+The target may also be overridden by setting the &cv-link-POTDOMAIN;
+&consvar; or providing it as an override to the &b-POTUpdate; builder:
</para>
-<example_commands>
- # SConstruct script
- env = Environment( tools = ['default', 'xgettext'] )
- env['POTDOMAIN'] = "foo"
- env.POTUpdate(source = ["a.cpp", "b.cpp"]) # Creates foo.pot ...
- env.POTUpdate(POTDOMAIN = "bar", source = ["c.cpp", "d.cpp"]) # and bar.pot
-</example_commands>
+<programlisting language="python">
+# SConstruct script
+env = Environment(tools=['default', 'xgettext'])
+env['POTDOMAIN'] = "foo"
+env.POTUpdate(source=["a.cpp", "b.cpp"]) # Creates foo.pot ...
+env.POTUpdate(POTDOMAIN="bar", source=["c.cpp", "d.cpp"]) # and bar.pot
+</programlisting>
<para>
<emphasis>Example 3.</emphasis>
-The sources may be specified within separate file, for example
+The <parameter>source</parameter> parameter may also be omitted,
+if it is specified in a separate file, for example
<filename>POTFILES.in</filename>:
</para>
-<example_commands>
- # POTFILES.in in 'po/' subdirectory
- ../a.cpp
- ../b.cpp
- # end of file
-</example_commands>
+<programlisting>
+# POTFILES.in in 'po/' subdirectory
+../a.cpp
+../b.cpp
+# end of file
+</programlisting>
<para>
The name of the file (<filename>POTFILES.in</filename>) containing the list of
sources is provided via &cv-link-XGETTEXTFROM;:
</para>
-<example_commands>
- # SConstruct file in 'po/' subdirectory
- env = Environment( tools = ['default', 'xgettext'] )
- env.POTUpdate(XGETTEXTFROM = 'POTFILES.in')
-</example_commands>
+<programlisting language="python">
+# SConstruct file in 'po/' subdirectory
+env = Environment(tools=['default', 'xgettext'])
+env.POTUpdate(XGETTEXTFROM='POTFILES.in')
+</programlisting>
<para>
<emphasis>Example 4.</emphasis>
-You may use &cv-link-XGETTEXTPATH; to define source search path. Assume, for
-example, that you have files <filename>a.cpp</filename>,
+You can use &cv-link-XGETTEXTPATH; to define the source search path.
+Assume, for example, that you have files <filename>a.cpp</filename>,
<filename>b.cpp</filename>, <filename>po/SConstruct</filename>,
-<filename>po/POTFILES.in</filename>. Then your <literal>POT</literal>-related
-files could look as below:
+<filename>po/POTFILES.in</filename>.
+Then your <literal>POT</literal>-related files could look like this:
</para>
-<example_commands>
- # POTFILES.in in 'po/' subdirectory
- a.cpp
- b.cpp
- # end of file
-</example_commands>
+<programlisting>
+# POTFILES.in in 'po/' subdirectory
+a.cpp
+b.cpp
+# end of file
+</programlisting>
-<example_commands>
- # SConstruct file in 'po/' subdirectory
- env = Environment( tools = ['default', 'xgettext'] )
- env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH='../')
-</example_commands>
+<programlisting language="python">
+# SConstruct file in 'po/' subdirectory
+env = Environment(tools=['default', 'xgettext'])
+env.POTUpdate(XGETTEXTFROM='POTFILES.in', XGETTEXTPATH='../')
+</programlisting>
<para>
<emphasis>Example 5.</emphasis>
-Multiple search directories may be defined within a list, i.e.
-<literal>XGETTEXTPATH = ['dir1', 'dir2', ...]</literal>. The order in the list
+Multiple search directories may be defined as a list, i.e.
+<literal>XGETTEXTPATH=['dir1', 'dir2', ...]</literal>. The order in the list
determines the search order of source files. The path to the first file found
is used.
</para>
@@ -1861,44 +1934,44 @@ is used.
<para>
Let's create <filename>0/1/po/SConstruct</filename> script:
</para>
-<example_commands>
- # SConstruct file in '0/1/po/' subdirectory
- env = Environment( tools = ['default', 'xgettext'] )
- env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../', '../../'])
-</example_commands>
+<programlisting language="python">
+# SConstruct file in '0/1/po/' subdirectory
+env = Environment(tools=['default', 'xgettext'])
+env.POTUpdate(XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../', '../../'])
+</programlisting>
<para>
and <filename>0/1/po/POTFILES.in</filename>:
</para>
-<example_commands>
- # POTFILES.in in '0/1/po/' subdirectory
- a.cpp
- # end of file
-</example_commands>
+<programlisting>
+# POTFILES.in in '0/1/po/' subdirectory
+a.cpp
+# end of file
+</programlisting>
<para>
Write two <filename>*.cpp</filename> files, the first one is
<filename>0/a.cpp</filename>:
</para>
-<example_commands>
- /* 0/a.cpp */
- gettext("Hello from ../../a.cpp")
-</example_commands>
+<programlisting language="c++">
+/* 0/a.cpp */
+gettext("Hello from ../../a.cpp")
+</programlisting>
<para>
and the second is <filename>0/1/a.cpp</filename>:
</para>
-<example_commands>
- /* 0/1/a.cpp */
- gettext("Hello from ../a.cpp")
-</example_commands>
+<programlisting language="c++">
+/* 0/1/a.cpp */
+gettext("Hello from ../a.cpp")
+</programlisting>
<para>
then run scons. You'll obtain <literal>0/1/po/messages.pot</literal> with the
message <literal>"Hello from ../a.cpp"</literal>. When you reverse order in
<varname>$XGETTEXTFOM</varname>, i.e. when you write SConscript as
</para>
-<example_commands>
- # SConstruct file in '0/1/po/' subdirectory
- env = Environment( tools = ['default', 'xgettext'] )
- env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../../', '../'])
-</example_commands>
+<programlisting language="python">
+# SConstruct file in '0/1/po/' subdirectory
+env = Environment(tools=['default', 'xgettext'])
+env.POTUpdate(XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../../', '../'])
+</programlisting>
<para>
then the <filename>messages.pot</filename> will contain
<literal>msgid "Hello from ../../a.cpp"</literal> line and not
@@ -1911,23 +1984,29 @@ then the <filename>messages.pot</filename> will contain
<term><function>POUpdate</function>()</term>
<term><replaceable>env</replaceable>.<methodname>POUpdate</methodname>()</term>
<listitem><para>
-The builder belongs to &t-link-msgmerge; tool. The builder updates
+The builder is set up by the &t-link-msgmerge; tool.
+part of the &t-link-gettext; toolset.
+The builder updates
<literal>PO</literal> files with <command>msgmerge(1)</command>, or initializes
-missing <literal>PO</literal> files as described in documentation of
-&t-link-msginit; tool and &b-link-POInit; builder (see also
-&cv-link-POAUTOINIT;). Note, that &b-POUpdate; <emphasis>does not add its
-targets to <literal>po-create</literal> alias</emphasis> as &b-link-POInit;
-does.
+missing <literal>PO</literal> files as described in the documentation of the
+&t-link-msginit; tool and the &b-link-POInit; builder (see also
+&cv-link-POAUTOINIT;).
+&b-POUpdate; is a single-source builder.
+The <parameter>source</parameter> parameter
+can also be omitted if &cv-link-LINGUAS_FILE; is set.
</para>
<para>
-Target nodes defined through &b-POUpdate; are not built by default
-(they're <literal>Ignore</literal>d from <literal>'.'</literal> node). Instead,
-they are added automatically to special <literal>Alias</literal>
+The target nodes are <emphasis>not</emphasis>
+selected for building by default (e.g. <userinput>scons .</userinput>).
+Instead, they are added automatically to special &f-link-Alias;
(<literal>'po-update'</literal> by default). The alias name may be changed
-through the &cv-link-POUPDATE_ALIAS; construction variable. You can easily
-update <literal>PO</literal> files in your project by <command>scons
-po-update</command>.
+through the &cv-link-POUPDATE_ALIAS; &consvar;. You can easily
+update <literal>PO</literal> files in your project by
+<userinput>scons po-update</userinput>.
+Note that &b-POUpdate; does not add its
+targets to the <literal>po-create</literal> alias as &b-link-POInit;
+does.
</para>
<para>
@@ -1937,49 +2016,44 @@ Update <filename>en.po</filename> and <filename>pl.po</filename> from
assuming that the later one exists or there is rule to build it (see
&b-link-POTUpdate;):
</para>
-<example_commands>
- # ...
- env.POUpdate(['en','pl']) # messages.pot --&gt; [en.po, pl.po]
-</example_commands>
+<programlisting language="python">
+env.POUpdate(['en','pl']) # messages.pot --&gt; [en.po, pl.po]
+</programlisting>
<para>
<emphasis>Example 2.</emphasis>
Update <filename>en.po</filename> and <filename>pl.po</filename> from
<filename>foo.pot</filename> template:
</para>
-<example_commands>
- # ...
- env.POUpdate(['en', 'pl'], ['foo']) # foo.pot --&gt; [en.po, pl.pl]
-</example_commands>
+<programlisting language="python">
+env.POUpdate(['en', 'pl'], ['foo']) # foo.pot --&gt; [en.po, pl.pl]
+</programlisting>
<para>
<emphasis>Example 3.</emphasis>
Update <filename>en.po</filename> and <filename>pl.po</filename> from
<filename>foo.pot</filename> (another version):
</para>
-<example_commands>
- # ...
- env.POUpdate(['en', 'pl'], POTDOMAIN='foo') # foo.pot -- &gt; [en.po, pl.pl]
-</example_commands>
+<programlisting language="python">
+env.POUpdate(['en', 'pl'], POTDOMAIN='foo') # foo.pot -- &gt; [en.po, pl.pl]
+</programlisting>
<para>
<emphasis>Example 4.</emphasis>
Update files for languages defined in <filename>LINGUAS</filename> file. The
files are updated from <filename>messages.pot</filename> template:
</para>
-<example_commands>
- # ...
- env.POUpdate(LINGUAS_FILE = 1) # needs 'LINGUAS' file
-</example_commands>
+<programlisting language="python">
+env.POUpdate(LINGUAS_FILE=True) # needs 'LINGUAS' file
+</programlisting>
<para>
<emphasis>Example 5.</emphasis>
Same as above, but update from <filename>foo.pot</filename> template:
</para>
-<example_commands>
- # ...
- env.POUpdate(LINGUAS_FILE = 1, source = ['foo'])
-</example_commands>
+<programlisting language="python">
+env.POUpdate(LINGUAS_FILE=True, source=['foo'])
+</programlisting>
<para>
<emphasis>Example 6.</emphasis>
@@ -1987,20 +2061,19 @@ Update <filename>en.po</filename> and <filename>pl.po</filename> plus files for
languages defined in <filename>LINGUAS</filename> file. The files are updated
from <filename>messages.pot</filename> template:
</para>
-<example_commands>
- # produce 'en.po', 'pl.po' + files defined in 'LINGUAS':
- env.POUpdate(['en', 'pl' ], LINGUAS_FILE = 1)
-</example_commands>
+<programlisting language="python">
+# produce 'en.po', 'pl.po' + files defined in 'LINGUAS':
+env.POUpdate(['en', 'pl' ], LINGUAS_FILE=True)
+</programlisting>
<para>
<emphasis>Example 7.</emphasis>
Use &cv-link-POAUTOINIT; to automatically initialize <literal>PO</literal> file
if it doesn't exist:
</para>
-<example_commands>
- # ...
- env.POUpdate(LINGUAS_FILE = 1, POAUTOINIT = 1)
-</example_commands>
+<programlisting language="python">
+env.POUpdate(LINGUAS_FILE=True, POAUTOINIT=True)
+</programlisting>
<para>
<emphasis>Example 8.</emphasis>
@@ -2009,13 +2082,12 @@ Update <literal>PO</literal> files for languages defined in
<filename>foo.pot</filename> template. All necessary settings are
pre-configured via environment.
</para>
-<example_commands>
- # ...
- env['POAUTOINIT'] = 1
- env['LINGUAS_FILE'] = 1
- env['POTDOMAIN'] = 'foo'
- env.POUpdate()
-</example_commands>
+<programlisting language="python">
+env['POAUTOINIT'] = True
+env['LINGUAS_FILE'] = True
+env['POTDOMAIN'] = 'foo'
+env.POUpdate()
+</programlisting>
</listitem>
</varlistentry>
@@ -2508,7 +2580,7 @@ are flattened. See also &b-link-Textfile;.
</para>
<para>
-By default the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
+By default, the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
Examples:
</para>
@@ -2531,7 +2603,7 @@ it may be either a Python dictionary or a sequence of
If it is a dictionary it is converted into a list of tuples
with unspecified order,
so if one key is a prefix of another key
-or if one substitution could be further expanded by another subsitition,
+or if one substitution could be further expanded by another substitution,
it is unpredictable whether the expansion will occur.
</para>
@@ -2562,7 +2634,7 @@ env.Substfile('foo.in', SUBST_DICT=bad_foo)
good_foo = [('$foobar', '$foobar'), ('$foo', '$foo')]
env.Substfile('foo.in', SUBST_DICT=good_foo)
-# UNPREDICTABLE - one substitution could be futher expanded
+# UNPREDICTABLE - one substitution could be further expanded
bad_bar = {'@bar@': '@soap@', '@soap@': 'lye'}
env.Substfile('bar.in', SUBST_DICT=bad_bar)
@@ -2654,7 +2726,7 @@ and &cv-link-TEXTFILESUFFIX; &consvars;
are automatically added to the target if they are not already present.
</para>
<para>
-By default the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
+By default, the target file encoding is "utf-8" and can be changed by &cv-link-FILE_ENCODING;
Examples:
</para>
@@ -2668,7 +2740,7 @@ env.Textfile(target='bar', source=['lalala', 'tanteratei'], LINESEPARATOR='|*')
# nested lists are flattened automatically
env.Textfile(target='blob', source=['lalala', ['Goethe', 42, 'Schiller'], 'tanteratei'])
-# files may be used as input by wraping them in File()
+# files may be used as input by wrapping them in File()
env.Textfile(
target='concat', # concatenate files with a marker between
source=[File('concat1'), File('concat2')],
@@ -2705,54 +2777,56 @@ env.Textfile(
<term><function>Translate</function>()</term>
<term><replaceable>env</replaceable>.<methodname>Translate</methodname>()</term>
<listitem><para>
-This pseudo-builder belongs to &t-link-gettext; toolset. The builder extracts
-internationalized messages from source files, updates <literal>POT</literal>
-template (if necessary) and then updates <literal>PO</literal> translations (if
-necessary). If &cv-link-POAUTOINIT; is set, missing <literal>PO</literal> files
+This pseudo-Builder is part of the &t-link-gettext; toolset.
+The builder extracts internationalized messages from source files,
+updates the <literal>POT</literal> template (if necessary)
+and then updates <literal>PO</literal> translations (if necessary).
+If &cv-link-POAUTOINIT; is set, missing <literal>PO</literal> files
will be automatically created (i.e. without translator person intervention).
The variables &cv-link-LINGUAS_FILE; and &cv-link-POTDOMAIN; are taken into
-acount too. All other construction variables used by &b-link-POTUpdate;, and
+account too. All other construction variables used by &b-link-POTUpdate;, and
&b-link-POUpdate; work here too.
</para>
<para>
<emphasis>Example 1</emphasis>.
The simplest way is to specify input files and output languages inline in
-a SCons script when invoking &b-Translate;
+a SCons script when invoking &b-Translate;:
</para>
-<example_commands>
+<programlisting language="python">
# SConscript in 'po/' directory
-env = Environment( tools = ["default", "gettext"] )
-env['POAUTOINIT'] = 1
-env.Translate(['en','pl'], ['../a.cpp','../b.cpp'])
-</example_commands>
+env = Environment(tools=["default", "gettext"])
+env['POAUTOINIT'] = True
+env.Translate(['en', 'pl'], ['../a.cpp', '../b.cpp'])
+</programlisting>
<para>
<emphasis>Example 2</emphasis>.
-If you wish, you may also stick to conventional style known from
+If you wish, you may also stick to the conventional style known from
<productname>autotools</productname>, i.e. using
<filename>POTFILES.in</filename> and <filename>LINGUAS</filename> files
+to specify the targets and sources:
</para>
-<example_commands>
+<programlisting language="python">
# LINGUAS
en pl
-#end
-</example_commands>
+# end
+</programlisting>
-<example_commands>
+<programlisting>
# POTFILES.in
a.cpp
b.cpp
# end
-</example_commands>
+</programlisting>
-<example_commands>
+<programlisting language="python">
# SConscript
-env = Environment( tools = ["default", "gettext"] )
-env['POAUTOINIT'] = 1
+env = Environment(tools=["default", "gettext"])
+env['POAUTOINIT'] = True
env['XGETTEXTPATH'] = ['../']
-env.Translate(LINGUAS_FILE = 1, XGETTEXTFROM = 'POTFILES.in')
-</example_commands>
+env.Translate(LINGUAS_FILE=True, XGETTEXTFROM='POTFILES.in')
+</programlisting>
<para>
The last approach is perhaps the recommended one. It allows easily split
@@ -2765,7 +2839,7 @@ factor" synchronizing these two scripts is then the content of
<filename>LINGUAS</filename> file. Note, that the updated
<literal>POT</literal> and <literal>PO</literal> files are usually going to be
committed back to the repository, so they must be updated within the source
-directory (and not in variant directories). Additionaly, the file listing of
+directory (and not in variant directories). Additionally, the file listing of
<filename>po/</filename> directory contains <filename>LINGUAS</filename> file,
so the source tree looks familiar to translators, and they may work with the
project in their usual way.
@@ -2775,7 +2849,7 @@ project in their usual way.
<emphasis>Example 3</emphasis>.
Let's prepare a development tree as below
</para>
-<example_commands>
+<programlisting>
project/
+ SConstruct
+ build/
@@ -2785,52 +2859,55 @@ Let's prepare a development tree as below
+ SConscript.i18n
+ POTFILES.in
+ LINGUAS
-</example_commands>
+</programlisting>
<para>
-with <filename>build</filename> being variant directory. Write the top-level
+with <filename>build</filename> being the variant directory.
+Write the top-level
<filename>SConstruct</filename> script as follows
</para>
-<example_commands>
- # SConstruct
- env = Environment( tools = ["default", "gettext"] )
- VariantDir('build', 'src', duplicate = 0)
- env['POAUTOINIT'] = 1
- SConscript('src/po/SConscript.i18n', exports = 'env')
- SConscript('build/po/SConscript', exports = 'env')
-</example_commands>
+<programlisting language="python">
+# SConstruct
+env = Environment(tools=["default", "gettext"])
+VariantDir('build', 'src', duplicate=False)
+env['POAUTOINIT'] = True
+SConscript('src/po/SConscript.i18n', exports='env')
+SConscript('build/po/SConscript', exports='env')
+</programlisting>
<para>
the <filename>src/po/SConscript.i18n</filename> as
</para>
-<example_commands>
- # src/po/SConscript.i18n
- Import('env')
- env.Translate(LINGUAS_FILE=1, XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../'])
-</example_commands>
+<programlisting language="python">
+# src/po/SConscript.i18n
+Import('env')
+env.Translate(LINGUAS_FILE=True, XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../'])
+</programlisting>
<para>
and the <filename>src/po/SConscript</filename>
</para>
-<example_commands>
- # src/po/SConscript
- Import('env')
- env.MOFiles(LINGUAS_FILE = 1)
-</example_commands>
+<programlisting language="python">
+# src/po/SConscript
+Import('env')
+env.MOFiles(LINGUAS_FILE=True)
+</programlisting>
<para>
-Such setup produces <literal>POT</literal> and <literal>PO</literal> files
-under source tree in <filename>src/po/</filename> and binary
-<literal>MO</literal> files under variant tree in
+Such a setup produces <literal>POT</literal> and <literal>PO</literal> files
+under the source tree in <filename>src/po/</filename> and binary
+<literal>MO</literal> files under the variant tree in
<filename>build/po/</filename>. This way the <literal>POT</literal> and
<literal>PO</literal> files are separated from other output files, which must
not be committed back to source repositories (e.g. <literal>MO</literal>
files).
</para>
-<para>
-<note><para>In above example, the <literal>PO</literal> files are not updated,
-nor created automatically when you issue <command>scons '.'</command> command.
-The files must be updated (created) by hand via <command>scons
-po-update</command> and then <literal>MO</literal> files can be compiled by
-running <command>scons '.'</command>.</para></note>
-</para>
+<note><para>In the above example,
+the <literal>PO</literal> files are not updated,
+nor created automatically when you issue the command
+<userinput>scons .</userinput>.
+The files must be updated (created) by hand via
+<userinput>scons po-update</userinput>
+and then <literal>MO</literal> files can be compiled by
+running <userinput>scons .</userinput>.
+</para></note>
</listitem>
</varlistentry>
diff --git a/doc/generated/examples/caching_ex-random_1.xml b/doc/generated/examples/caching_ex-random_1.xml
index 0f0cfe1..d7e5ecc 100644
--- a/doc/generated/examples/caching_ex-random_1.xml
+++ b/doc/generated/examples/caching_ex-random_1.xml
@@ -1,8 +1,8 @@
<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput>
-cc -o f1.o -c f1.c
-cc -o f4.o -c f4.c
-cc -o f5.o -c f5.c
cc -o f2.o -c f2.c
+cc -o f4.o -c f4.c
cc -o f3.o -c f3.c
+cc -o f1.o -c f1.c
+cc -o f5.o -c f5.c
cc -o prog f1.o f2.o f3.o f4.o f5.o
</screen>
diff --git a/doc/generated/examples/commandline_PackageVariable_1.xml b/doc/generated/examples/commandline_PackageVariable_1.xml
index 367638f..49c6c85 100644
--- a/doc/generated/examples/commandline_PackageVariable_1.xml
+++ b/doc/generated/examples/commandline_PackageVariable_1.xml
@@ -3,7 +3,7 @@ cc -o foo.o -c -DPACKAGE="/opt/location" foo.c
% <userinput>scons -Q PACKAGE=/usr/local/location foo.o</userinput>
cc -o foo.o -c -DPACKAGE="/usr/local/location" foo.c
% <userinput>scons -Q PACKAGE=yes foo.o</userinput>
-cc -o foo.o -c -DPACKAGE="True" foo.c
+cc -o foo.o -c -DPACKAGE="/opt/location" foo.c
% <userinput>scons -Q PACKAGE=no foo.o</userinput>
cc -o foo.o -c -DPACKAGE="False" foo.c
</screen>
diff --git a/doc/generated/examples/troubleshoot_explain1_3.xml b/doc/generated/examples/troubleshoot_explain1_3.xml
index e658d89..d301ff3 100644
--- a/doc/generated/examples/troubleshoot_explain1_3.xml
+++ b/doc/generated/examples/troubleshoot_explain1_3.xml
@@ -2,5 +2,5 @@
cp file.in file.oout
scons: warning: Cannot find target file.out after building
-File "/Users/bdbaddog/devel/scons/git/as_scons/scripts/scons.py", line 97, in &lt;module&gt;
+File "/Users/bdbaddog/devel/scons/git/users/prs/scripts/scons.py", line 97, in &lt;module&gt;
</screen>
diff --git a/doc/generated/examples/troubleshoot_taskmastertrace_1.xml b/doc/generated/examples/troubleshoot_taskmastertrace_1.xml
index 5d10fea..fdc755d 100644
--- a/doc/generated/examples/troubleshoot_taskmastertrace_1.xml
+++ b/doc/generated/examples/troubleshoot_taskmastertrace_1.xml
@@ -1,8 +1,8 @@
<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --taskmastertrace=- prog</userinput>
-Job.NewParallel._work(): [Thread:8682049344] Gained exclusive access
-Job.NewParallel._work(): [Thread:8682049344] Starting search
-Job.NewParallel._work(): [Thread:8682049344] Found 0 completed tasks to process
-Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks
+Job.NewParallel._work(): [Thread:8445988672] Gained exclusive access
+Job.NewParallel._work(): [Thread:8445988672] Starting search
+Job.NewParallel._work(): [Thread:8445988672] Found 0 completed tasks to process
+Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks
Taskmaster: Looking for a node to evaluate
Taskmaster: Considering node &lt;no_state 0 'prog'&gt; and its children:
@@ -18,12 +18,12 @@ Taskmaster: Evaluating &lt;pending 0 'prog.c'&gt;
Task.make_ready_current(): node &lt;pending 0 'prog.c'&gt;
Task.prepare(): node &lt;up_to_date 0 'prog.c'&gt;
-Job.NewParallel._work(): [Thread:8682049344] Found internal task
+Job.NewParallel._work(): [Thread:8445988672] Found internal task
Task.executed_with_callbacks(): node &lt;up_to_date 0 'prog.c'&gt;
Task.postprocess(): node &lt;up_to_date 0 'prog.c'&gt;
Task.postprocess(): removing &lt;up_to_date 0 'prog.c'&gt;
Task.postprocess(): adjusted parent ref count &lt;pending 1 'prog.o'&gt;
-Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks
+Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks
Taskmaster: Looking for a node to evaluate
Taskmaster: Considering node &lt;no_state 0 'inc.h'&gt; and its children:
@@ -31,12 +31,12 @@ Taskmaster: Evaluating &lt;pending 0 'inc.h'&gt;
Task.make_ready_current(): node &lt;pending 0 'inc.h'&gt;
Task.prepare(): node &lt;up_to_date 0 'inc.h'&gt;
-Job.NewParallel._work(): [Thread:8682049344] Found internal task
+Job.NewParallel._work(): [Thread:8445988672] Found internal task
Task.executed_with_callbacks(): node &lt;up_to_date 0 'inc.h'&gt;
Task.postprocess(): node &lt;up_to_date 0 'inc.h'&gt;
Task.postprocess(): removing &lt;up_to_date 0 'inc.h'&gt;
Task.postprocess(): adjusted parent ref count &lt;pending 0 'prog.o'&gt;
-Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks
+Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks
Taskmaster: Looking for a node to evaluate
Taskmaster: Considering node &lt;pending 0 'prog.o'&gt; and its children:
@@ -46,19 +46,19 @@ Taskmaster: Evaluating &lt;pending 0 'prog.o'&gt;
Task.make_ready_current(): node &lt;pending 0 'prog.o'&gt;
Task.prepare(): node &lt;executing 0 'prog.o'&gt;
-Job.NewParallel._work(): [Thread:8682049344] Found task requiring execution
-Job.NewParallel._work(): [Thread:8682049344] Executing task
+Job.NewParallel._work(): [Thread:8445988672] Found task requiring execution
+Job.NewParallel._work(): [Thread:8445988672] Executing task
Task.execute(): node &lt;executing 0 'prog.o'&gt;
cc -o prog.o -c -I. prog.c
-Job.NewParallel._work(): [Thread:8682049344] Enqueueing executed task results
-Job.NewParallel._work(): [Thread:8682049344] Gained exclusive access
-Job.NewParallel._work(): [Thread:8682049344] Starting search
-Job.NewParallel._work(): [Thread:8682049344] Found 1 completed tasks to process
+Job.NewParallel._work(): [Thread:8445988672] Enqueueing executed task results
+Job.NewParallel._work(): [Thread:8445988672] Gained exclusive access
+Job.NewParallel._work(): [Thread:8445988672] Starting search
+Job.NewParallel._work(): [Thread:8445988672] Found 1 completed tasks to process
Task.executed_with_callbacks(): node &lt;executing 0 'prog.o'&gt;
Task.postprocess(): node &lt;executed 0 'prog.o'&gt;
Task.postprocess(): removing &lt;executed 0 'prog.o'&gt;
Task.postprocess(): adjusted parent ref count &lt;pending 0 'prog'&gt;
-Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks
+Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks
Taskmaster: Looking for a node to evaluate
Taskmaster: Considering node &lt;pending 0 'prog'&gt; and its children:
@@ -67,21 +67,21 @@ Taskmaster: Evaluating &lt;pending 0 'prog'&gt;
Task.make_ready_current(): node &lt;pending 0 'prog'&gt;
Task.prepare(): node &lt;executing 0 'prog'&gt;
-Job.NewParallel._work(): [Thread:8682049344] Found task requiring execution
-Job.NewParallel._work(): [Thread:8682049344] Executing task
+Job.NewParallel._work(): [Thread:8445988672] Found task requiring execution
+Job.NewParallel._work(): [Thread:8445988672] Executing task
Task.execute(): node &lt;executing 0 'prog'&gt;
cc -o prog prog.o
-Job.NewParallel._work(): [Thread:8682049344] Enqueueing executed task results
-Job.NewParallel._work(): [Thread:8682049344] Gained exclusive access
-Job.NewParallel._work(): [Thread:8682049344] Starting search
-Job.NewParallel._work(): [Thread:8682049344] Found 1 completed tasks to process
+Job.NewParallel._work(): [Thread:8445988672] Enqueueing executed task results
+Job.NewParallel._work(): [Thread:8445988672] Gained exclusive access
+Job.NewParallel._work(): [Thread:8445988672] Starting search
+Job.NewParallel._work(): [Thread:8445988672] Found 1 completed tasks to process
Task.executed_with_callbacks(): node &lt;executing 0 'prog'&gt;
Task.postprocess(): node &lt;executed 0 'prog'&gt;
-Job.NewParallel._work(): [Thread:8682049344] Searching for new tasks
+Job.NewParallel._work(): [Thread:8445988672] Searching for new tasks
Taskmaster: Looking for a node to evaluate
Taskmaster: No candidate anymore.
-Job.NewParallel._work(): [Thread:8682049344] Found no task requiring execution, and have no jobs: marking complete
-Job.NewParallel._work(): [Thread:8682049344] Gained exclusive access
-Job.NewParallel._work(): [Thread:8682049344] Completion detected, breaking from main loop
+Job.NewParallel._work(): [Thread:8445988672] Found no task requiring execution, and have no jobs: marking complete
+Job.NewParallel._work(): [Thread:8445988672] Gained exclusive access
+Job.NewParallel._work(): [Thread:8445988672] Completion detected, breaking from main loop
</screen>
diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen
index 8563d66..9668af8 100644
--- a/doc/generated/functions.gen
+++ b/doc/generated/functions.gen
@@ -26,13 +26,12 @@ for a complete explanation of the arguments and behavior.
<para>
Note that the &f-env-Action;
form of the invocation will expand
-construction variables in any argument strings,
+&consvars; in any argument strings,
including the
<parameter>action</parameter>
argument, at the time it is called
-using the construction variables in the
-<replaceable>env</replaceable>
-construction environment through which
+using the &consvars; in the
+&consenv; through which
&f-env-Action; was called.
The &f-Action; global function
form delays all variable expansion
@@ -98,7 +97,7 @@ but with a few additional capabilities noted below.
See the
<ulink url="https://docs.python.org/3/library/optparse.html">
optparse documentation</ulink>
-for a thorough discussion of its option-processing capabities.
+for a thorough discussion of its option-processing capabilities.
All options added through &f-AddOption; are placed
in a special "Local Options" option group.
</para>
@@ -440,7 +439,7 @@ Example:
AllowSubstExceptions()
# Also allow a string containing a zero-division expansion
-# like '${1 / 0}' to evalute to ''.
+# like '${1 / 0}' to evaluate to ''.
AllowSubstExceptions(IndexError, NameError, ZeroDivisionError)
</example_commands>
</listitem>
@@ -451,7 +450,7 @@ AllowSubstExceptions(IndexError, NameError, ZeroDivisionError)
<listitem><para>
Marks each given
<parameter>target</parameter>
-so that it is always assumed to be out of date,
+so that it is always assumed to be out-of-date,
and will always be rebuilt if needed.
Note, however, that
&f-AlwaysBuild;
@@ -506,15 +505,15 @@ named <parameter>key</parameter>,
then <parameter>key</parameter> is simply
stored with a value of <parameter>val</parameter>.
Otherwise, <parameter>val</parameter> is
-combinined with the existing value,
+combined with the existing value,
possibly converting into an appropriate type
which can hold the expanded contents.
There are a few special cases to be aware of.
Normally, when two strings are combined,
the result is a new string containing their concatenation
(and you are responsible for supplying any needed separation);
-however, the contents of &cv-link-CPPDEFINES; will
-will be postprocessed by adding a prefix and/or suffix
+however, the contents of &cv-link-CPPDEFINES;
+will be post-processed by adding a prefix and/or suffix
to each entry when the command line is produced,
so &SCons; keeps them separate -
appending a string will result in a separate string entry,
@@ -630,7 +629,7 @@ scons: `.' is up to date.
<para>
<emphasis>Changed in version 4.5</emphasis>:
-clarifined the use of tuples vs. other types,
+clarified the use of tuples vs. other types,
handling is now consistent across the four functions.
</para>
@@ -657,7 +656,7 @@ See &cv-link-CPPDEFINES; for more details.
<para>
Appending a string <parameter>val</parameter>
-to a dictonary-typed &consvar; enters
+to a dictionary-typed &consvar; enters
<parameter>val</parameter> as the key in the dictionary,
and <literal>None</literal> as its value.
Using a tuple type to supply a key-value pair
@@ -784,14 +783,14 @@ for a complete explanation of the arguments and behavior.
Note that the
<function>env.Builder</function>()
form of the invocation will expand
-construction variables in any arguments strings,
+&consvars; in any arguments strings,
including the
<parameter>action</parameter>
argument,
at the time it is called
-using the construction variables in the
+using the &consvars; in the
<varname>env</varname>
-construction environment through which
+&consenv; through which
&f-env-Builder; was called.
The
&f-Builder;
@@ -822,12 +821,12 @@ disables derived file caching.
Calling the environment method
&f-link-env-CacheDir;
limits the effect to targets built
-through the specified construction environment.
+through the specified &consenv;.
Calling the global function
&f-link-CacheDir;
sets a global default
that will be used by all targets built
-through construction environments
+through &consenvs;
that do not set up environment-specific
caching by calling &f-env-CacheDir;.
</para>
@@ -950,7 +949,7 @@ either as separate arguments to the
&f-Clean;
method, or as a list.
&f-Clean;
-will also accept the return value of any of the construction environment
+will also accept the return value of the &consenv;
Builder methods.
Examples:
</para>
@@ -982,7 +981,7 @@ Clean(['foo', 'bar'], 'something_else_to_clean')
In this example,
installing the project creates a subdirectory for the documentation.
This statement causes the subdirectory to be removed
-if the project is deinstalled.
+if the project is uninstalled.
</para>
<example_commands>
Clean(docdir, os.path.join(docdir, projectname))
@@ -1207,8 +1206,8 @@ for a complete explanation of the arguments and behavior.
<varlistentry id="f-DebugOptions">
<term><function>DebugOptions</function>(<parameter>[json]</parameter>)</term>
<listitem><para>
-Allows setting options for SCons debug options. Currently the only supported value is
- <emphasis>json</emphasis> which sets the path to the json file created when
+Allows setting options for SCons debug options. Currently, the only supported value is
+ <emphasis>json</emphasis> which sets the path to the JSON file created when
<literal>--debug=json</literal> is set.
</para>
<example_commands>
@@ -1222,13 +1221,11 @@ DebugOptions(json='#/build/output/scons_stats.json')
<term><replaceable>env</replaceable>.<methodname>Decider</methodname>(<parameter>function</parameter>)</term>
<listitem><para>
Specifies that all up-to-date decisions for
-targets built through this construction environment
-will be handled by the specified
-<parameter>function</parameter>.
+targets built through this &consenv;
+will be handled by <parameter>function</parameter>.
<parameter>function</parameter> can be the name of
a function or one of the following strings
-that specify the predefined decision function
-that will be applied:
+that specify a predefined decider function:
</para>
<para>
@@ -1237,7 +1234,7 @@ that will be applied:
<term><literal>"content"</literal></term>
<listitem>
<para>
-Specifies that a target shall be considered out of date and rebuilt
+Specifies that a target shall be considered out-of-date and rebuilt
if the dependency's content has changed since the last time
the target was built,
as determined by performing a checksum
@@ -1259,7 +1256,7 @@ can still be used as a synonym, but is deprecated.
<term><literal>"content-timestamp"</literal></term>
<listitem>
<para>
-Specifies that a target shall be considered out of date and rebuilt
+Specifies that a target shall be considered out-of-date and rebuilt
if the dependency's content has changed since the last time
the target was built,
except that dependencies with a timestamp that matches
@@ -1296,7 +1293,7 @@ can still be used as a synonym, but is deprecated.
<term><literal>"timestamp-newer"</literal></term>
<listitem>
<para>
-Specifies that a target shall be considered out of date and rebuilt
+Specifies that a target shall be considered out-of-date and rebuilt
if the dependency's timestamp is newer than the target file's timestamp.
This is the behavior of the classic Make utility,
and
@@ -1310,7 +1307,7 @@ can be used a synonym for
<term><literal>"timestamp-match"</literal></term>
<listitem>
<para>
-Specifies that a target shall be considered out of date and rebuilt
+Specifies that a target shall be considered out-of-date and rebuilt
if the dependency's timestamp is different than the
timestamp recorded the last time the target was built.
This provides behavior very similar to the classic Make utility
@@ -1335,7 +1332,7 @@ Examples:
Decider('timestamp-match')
# Use hash content signatures for any targets built
-# with the attached construction environment.
+# with the attached &consenv;.
env.Decider('content')
</example_commands>
@@ -1356,7 +1353,7 @@ The Node (file) which
should cause the
<parameter>target</parameter>
to be rebuilt
-if it has "changed" since the last tme
+if it has "changed" since the last time
<parameter>target</parameter>
was built.
</para>
@@ -1431,7 +1428,7 @@ otherwise
<emphasis>not</emphasis>
be rebuilt).
Note that the decision can be made
-using whatever criteria are appopriate.
+using whatever criteria are appropriate.
Ignoring some or all of the function arguments
is perfectly normal.
</para>
@@ -1538,7 +1535,7 @@ build phase begins, if has not already been done.
However, calling it explicitly provides the opportunity to
affect and examine its contents.
Instantiation occurs even if nothing in the build system
-appars to use it, due to internal uses.
+appears to use it, due to internal uses.
</para>
<para>
@@ -1617,14 +1614,20 @@ but will not include any such extension in the return value.
</listitem>
</varlistentry>
<varlistentry id="f-Dictionary">
- <term><replaceable>env</replaceable>.<methodname>Dictionary</methodname>(<parameter>[vars]</parameter>)</term>
+ <term><replaceable>env</replaceable>.<methodname>Dictionary</methodname>(<parameter>[var, ...], [as_dict=]</parameter>)</term>
<listitem><para>
-Returns a dictionary object
-containing the &consvars; in the &consenv;.
-If there are any arguments specified,
-the values of the specified &consvars;
-are returned as a string (if one
-argument) or as a list of strings.
+Return an object containing &consvars; from
+<parameter>env</parameter>.
+If <parameter>var</parameter> is omitted,
+all the &consvars; with their values
+are returned in a <type>dict</type>.
+If <parameter>var</parameter> is specified,
+and <parameter>as_dict</parameter> is true,
+the specified &consvars; are returned in a <type>dict</type>;
+otherwise (the default, for backwards compatibility),
+values only are returned,
+as a scalar if one <parameter>var</parameter> is given,
+or as a list if multiples.
</para>
<para>
@@ -1639,8 +1642,8 @@ cc_values = env.Dictionary('CC', 'CCFLAGS', 'CCCOM')
<note><para>
The object returned by &f-link-env-Dictionary; should be treated
as a read-only view into the &consvars;.
-Some &consvars; have special internal handling,
-and making changes through the &f-env-Dictionary; object can bypass
+Some &consvars; require special internal handling,
+and modifying them through the &f-env-Dictionary; object can bypass
that handling and cause data inconsistencies.
The primary use of &f-env-Dictionary; is for diagnostic purposes -
it is used widely by test cases specifically because
@@ -1648,6 +1651,11 @@ it bypasses the special handling so that behavior
can be verified.
</para></note>
+<para>
+<emphasis>Changed in NEXT_RELEASE</emphasis>:
+<parameter>as_dict</parameter> added.
+</para>
+
</listitem>
</varlistentry>
<varlistentry id="f-Dir">
@@ -1688,22 +1696,28 @@ for more information.
</listitem>
</varlistentry>
<varlistentry id="f-Dump">
- <term><replaceable>env</replaceable>.<methodname>Dump</methodname>(<parameter>[key, ...], [format=]</parameter>)</term>
+ <term><replaceable>env</replaceable>.<methodname>Dump</methodname>(<parameter>[var, ...], [format=TYPE]</parameter>)</term>
<listitem><para>
-Serializes &consvars; from the current &consenv;
-to a string.
-The method supports the following formats specified by
-<parameter>format</parameter>,
-which must be used a a keyword argument:
+Serialize &consvars; from <parameter>env</parameter> to a string.
+If <varname>var</varname> is omitted,
+all the &consvars; are serialized.
+If one or more <varname>var</varname> values are supplied,
+only those variables and their values are serialized.
+</para>
+
+<para>
+The optional <parameter>format</parameter> string
+selects the serialization format:
</para>
<variablelist>
<varlistentry>
<term><literal>pretty</literal></term>
<listitem>
<para>
-Returns a pretty-printed representation of the variables
+Returns a pretty-printed representation
+of the &consvars; - the result will look like a
+&Python; <type>dict</type>
(this is the default).
-The variables will be presented in &Python; dict form.
</para>
</listitem>
</varlistentry>
@@ -1711,31 +1725,25 @@ The variables will be presented in &Python; dict form.
<term><literal>json</literal></term>
<listitem>
<para>
-Returns a JSON-formatted string representation of the variables.
+Returns a JSON-formatted representation of the variables.
The variables will be presented as a JSON object literal,
-the JSON equivalent of a &Python; dict.
+the JSON equivalent of a &Python; <type>dict</type>..
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
-If no <varname>key</varname> is supplied,
-all the &consvars; are serialized.
-If one or more keys are supplied,
-only those keys and their values are serialized.
-</para>
-
-<para>
-<emphasis>Changed in NEXT_VERSION</emphasis>:
+<emphasis>Changed in NEXT_RELEASE</emphasis>:
More than one <parameter>key</parameter> can be specified.
-The returned string always looks like a dict (or JSON equivalent);
+The returned string always looks like a <type>dict</type>
+(or equivalent in other formats);
previously a single key serialized only the value,
not the key with the value.
</para>
<para>
-This SConstruct:
+Examples: this &SConstruct;
</para>
<example_commands>
@@ -1757,7 +1765,7 @@ will print something like:
</example_commands>
<para>
-While this SConstruct:
+While this &SConstruct;:
</para>
<example_commands>
@@ -2184,7 +2192,7 @@ FindSourceFiles('src')
</example_commands>
<para>
-As you can see build support files (SConstruct in the above example)
+As you can see, build support files (&SConstruct; in the above example)
will also be returned by this function.
</para>
</listitem>
@@ -2656,8 +2664,8 @@ or (most commonly) relative to the directory of the current
&f-Glob; matches both files stored on disk and Nodes
which &SCons; already knows about, even if any corresponding
file is not currently stored on disk.
-The evironment method form (&f-env-Glob;)
-performs string substition on
+The environment method form (&f-env-Glob;)
+performs string substitution on
<parameter>pattern</parameter>
and returns whatever matches the resulting expanded pattern.
The results are sorted, unlike for the similar &Python;
@@ -2748,7 +2756,7 @@ If the optional
<parameter>source</parameter>
argument evaluates true,
and the local directory is a variant directory,
-then &f-Glob; returnes Nodes from
+then &f-Glob; returns Nodes from
the corresponding source directory,
rather than the local directory.
<!-- XXX what about generated files that don't exist in src but will be sources? -->
@@ -2782,7 +2790,7 @@ directory.)
The optional
<parameter>exclude</parameter>
argument may be set to a pattern or a list of patterns
-descibing files or directories
+describing files or directories
to filter out of the match list.
Elements matching a least one specified pattern will be excluded.
These patterns use the same syntax as for
@@ -2927,7 +2935,7 @@ Import("*")
The specified
<parameter>string</parameter>
will be preserved as-is
-and not have construction variables expanded.
+and not have &consvars; expanded.
</para>
</listitem>
</varlistentry>
@@ -2976,7 +2984,7 @@ In case of duplication,
any &consvar; names that end in
<literal>PATH</literal>
keep the left-most value so the
-path searcb order is not altered.
+path search order is not altered.
All other &consvars; keep
the right-most value.
If <literal>unique</literal> is false,
@@ -3026,7 +3034,7 @@ either as separate arguments to the
&f-NoCache;
method, or as a list.
&f-NoCache;
-will also accept the return value of any of the construction environment
+will also accept the return value of any of the &consenv;
Builder methods.
</para>
@@ -3074,7 +3082,7 @@ either as separate arguments to the
&f-NoClean;
method, or as a list.
&f-NoClean;
-will also accept the return value of any of the construction environment
+will also accept the return value of any of the &consenv;
Builder methods.
</para>
@@ -3115,7 +3123,7 @@ is omitted or <constant>None</constant>,
&f-link-env-MergeFlags; is used.
By default,
duplicate values are not
-added to any construction variables;
+added to any &consvars;;
you can specify
<parameter>unique=False</parameter>
to allow duplicate values to be added.
@@ -3138,11 +3146,11 @@ the output produced by <parameter>command</parameter>
in order to distribute it to appropriate &consvars;.
&f-env-MergeFlags; uses a separate function to
do that processing -
-see &f-link-env-ParseFlags; for the details, including a
-a table of options and corresponding construction variables.
+see &f-link-env-ParseFlags; for the details, including
+a table of options and corresponding &consvars;.
To provide alternative processing of the output of
<parameter>command</parameter>,
-you can suppply a custom
+you can supply a custom
<parameter>function</parameter>,
which must accept three arguments:
the &consenv; to modify,
@@ -3215,12 +3223,12 @@ function.
Parses one or more strings containing
typical command-line flags for GCC-style tool chains
and returns a dictionary with the flag values
-separated into the appropriate SCons construction variables.
+separated into the appropriate SCons &consvars;.
Intended as a companion to the
&f-link-env-MergeFlags;
method, but allows for the values in the returned dictionary
to be modified, if necessary,
-before merging them into the construction environment.
+before merging them into the &consenv;.
(Note that
&f-env-MergeFlags;
will call this method if its argument is not a dictionary,
@@ -3249,7 +3257,7 @@ See &f-link-ParseConfig; for more details.
<para>
Flag values are translated according to the prefix found,
-and added to the following construction variables:
+and added to the following &consvars;:
</para>
<example_commands>
@@ -3289,8 +3297,7 @@ and added to the following construction variables:
Any other strings not associated with options
are assumed to be the names of libraries
and added to the
-&cv-LIBS;
-construction variable.
+&cv-LIBS; &consvar;.
</para>
<para>
@@ -3315,7 +3322,7 @@ selected by <parameter>plat</parameter>
(defaults to the detected platform for the
current system)
that can be used to initialize
-a construction environment by passing it as the
+a &consenv; by passing it as the
<parameter>platform</parameter> keyword argument to the
&f-link-Environment; function.
</para>
@@ -3361,7 +3368,7 @@ Returns a list of the affected target nodes.
<term><replaceable>env</replaceable>.<methodname>Prepend</methodname>(<parameter>key=val, [...]</parameter>)</term>
<listitem><para>
Prepend values to &consvars; in the current &consenv;,
-Works like &f-link-env-Append; (see for details),
+works like &f-link-env-Append; (see for details),
except that values are added to the front,
rather than the end, of any existing value of the &consvar;
</para>
@@ -3566,7 +3573,7 @@ If the string contains the verbatim substring
it will be replaced with the Node.
Note that, for performance reasons, this is
<emphasis>not</emphasis>
-a regular SCons variable substition,
+a regular SCons variable substitution,
so you can not use other variables
or use curly braces.
The following example will print the name of
@@ -3666,7 +3673,7 @@ env = Environment(
<varlistentry id="f-Replace">
<term><replaceable>env</replaceable>.<methodname>Replace</methodname>(<parameter>key=val, [...]</parameter>)</term>
<listitem><para>
-Replaces construction variables in the Environment
+Replaces &consvars; in the Environment
with the specified keyword arguments.
</para>
@@ -3683,50 +3690,43 @@ env.Replace(CCFLAGS='-g', FOO='foo.xxx')
<term><function>Repository</function>(<parameter>directory</parameter>)</term>
<term><replaceable>env</replaceable>.<methodname>Repository</methodname>(<parameter>directory</parameter>)</term>
<listitem><para>
-Specifies that
+Sets
<parameter>directory</parameter>
-is a repository to be searched for files.
+as a repository to be searched for files contributing to the build.
Multiple calls to
&f-Repository;
-are legal,
-and each one adds to the list of
-repositories that will be searched.
+are allowed,
+with repositories searched in the given order.
+Repositories specified via command-line option
+have higher priority.
</para>
<para>
-To
+In
&scons;,
-a repository is a copy of the source tree,
-from the top-level directory on down,
-which may contain
-both source files and derived files
+a repository is partial or complete copy of the source tree,
+from the top-level directory down,
+containing source files
that can be used to build targets in
-the local source tree.
-The canonical example would be an
-official source tree maintained by an integrator.
-If the repository contains derived files,
-then the derived files should have been built using
-&scons;,
-so that the repository contains the necessary
-signature information to allow
-&scons;
-to figure out when it is appropriate to
-use the repository copy of a derived file,
-instead of building one locally.
+the current worktree.
+Repositories can also contain derived files.
+An example might be an official source tree maintained by an integrator.
+If a repository contains derived files,
+they should be the result of building with &SCons;,
+so a signature database (sconsign) is present
+in the repository,
+allowing better decisions on whether they are
+up-to-date or not.
</para>
<para>
Note that if an up-to-date derived file
already exists in a repository,
-&scons;
-will
+&scons; will
<emphasis>not</emphasis>
make a copy in the local directory tree.
-In order to guarantee that a local copy
-will be made,
-use the
-&f-link-Local;
-method.
+If you need a local copy to be made,
+use the &f-link-Local; method.
</para>
</listitem>
</varlistentry>
@@ -3769,7 +3769,7 @@ env.Requires('foo', 'file-that-must-be-built-before-foo')
Return to the calling SConscript, optionally
returning the values of variables named in
<varname>vars</varname>.
-Multiple strings contaning variable names may be passed to
+Multiple strings containing variable names may be passed to
&f-Return;. A string containing white space
is split into individual variable names.
Returns the value if one variable is specified,
@@ -4174,7 +4174,7 @@ in a separate
<filename>.sconsign</filename>
file in each directory,
not in a single combined database file.
-This is a backwards-compatibility meaure to support
+This is a backwards-compatibility measure to support
what was the default behavior
prior to &SCons; 0.97 (i.e. before 2008).
Use of this mode is discouraged and may be
@@ -4212,7 +4212,7 @@ SConsignFile(dbm_module=dbm.gnu)
<varlistentry id="f-SetDefault">
<term><replaceable>env</replaceable>.<methodname>SetDefault</methodname>(<parameter>key=val, [...]</parameter>)</term>
<listitem><para>
-Sets construction variables to default values specified with the keyword
+Sets &consvars; to default values specified with the keyword
arguments if (and only if) the variables are not already set.
The following statements are equivalent:
</para>
@@ -4836,7 +4836,7 @@ Returns a Node object representing the specified &Python;
Value Nodes can be used as dependencies of targets.
If the string representation of the Value Node
changes between &SCons; runs, it is considered
-out of date and any targets depending it will be rebuilt.
+out-of-date and any targets depending on it will be rebuilt.
Since Value Nodes have no filesystem representation,
timestamps are not used; the timestamp deciders
perform the same content-based up to date check.
diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen
index b2b1583..60fdf4b 100644
--- a/doc/generated/tools.gen
+++ b/doc/generated/tools.gen
@@ -465,33 +465,33 @@ Sets construction variables for the D language compiler GDC.
<varlistentry id="t-gettext">
<term>gettext</term>
<listitem><para>
-This is actually a toolset, which supports internationalization and
-localization of software being constructed with SCons. The toolset loads
-following tools:
+A toolset supporting internationalization and
+localization of software being constructed with &SCons;.
+The toolset loads the following tools:
</para>
<para>
<itemizedlist mark="opencircle">
<listitem><para>
- &t-link-xgettext; - to extract internationalized messages from source code to
- <literal>POT</literal> file(s),
+ &t-link-xgettext; - extract internationalized messages from source code to
+ <literal>POT</literal> file(s).
</para></listitem>
<listitem><para>
- &t-link-msginit; - may be optionally used to initialize <literal>PO</literal>
- files,
+ &t-link-msginit; - initialize <literal>PO</literal>
+ files during initial translation of a project.
</para></listitem>
<listitem><para>
- &t-link-msgmerge; - to update <literal>PO</literal> files, that already contain
+ &t-link-msgmerge; - update <literal>PO</literal> files that already contain
translated messages,</para></listitem>
<listitem><para>
- &t-link-msgfmt; - to compile textual <literal>PO</literal> file to binary
- installable <literal>MO</literal> file.
+ &t-link-msgfmt; - compile textual <literal>PO</literal> files to binary
+ installable <literal>MO</literal> files.
</para></listitem>
</itemizedlist>
</para>
<para>
-When you enable &t-gettext;, it internally loads all abovementioned tools,
+When you enable &t-gettext;, it internally loads all the above-mentioned tools,
so you're encouraged to see their individual documentation.
</para>
@@ -503,12 +503,12 @@ may be however interested in <emphasis>top-level</emphasis>
</para>
<para>
-To use &t-gettext; tools add <literal>'gettext'</literal> tool to your
-environment:
+To use the &t-gettext; tools, add the <literal>'gettext'</literal> tool to your
+&consenv;:
</para>
-<example_commands>
- env = Environment( tools = ['default', 'gettext'] )
-</example_commands>
+<programlisting language="python">
+env = Environment(tools=['default', 'gettext'])
+</programlisting>
</listitem>
</varlistentry>
<varlistentry id="t-gfortran">
@@ -529,7 +529,7 @@ Set construction variables for GNU linker/loader.
<varlistentry id="t-gs">
<term>gs</term>
<listitem><para>
-This Tool sets the required construction variables for working with
+This &f-Tool; sets the required construction variables for working with
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.
@@ -665,7 +665,7 @@ Sets construction variables for the D language compiler LDC2.
<varlistentry id="t-lex">
<term>lex</term>
<listitem><para>
-Sets construction variables for the &lex; lexical analyser.
+Sets construction variables for the &lex; lexical analyzer.
</para>
<para>Sets: &cv-link-LEX;, &cv-link-LEXCOM;, &cv-link-LEXFLAGS;, &cv-link-LEXUNISTD;.</para><para>Uses: &cv-link-LEXCOMSTR;, &cv-link-LEXFLAGS;, &cv-link-LEX_HEADER_FILE;, &cv-link-LEX_TABLES_FILE;.</para></listitem>
</varlistentry>
@@ -718,28 +718,35 @@ Sets construction variables for MinGW (Minimal Gnu on Windows).
<varlistentry id="t-msgfmt">
<term>msgfmt</term>
<listitem><para>
-This scons tool is a part of scons &t-link-gettext; toolset. It provides scons
-interface to <command>msgfmt(1)</command> command, which generates binary
-message catalog (<literal>MO</literal>) from a textual translation description
-(<literal>PO</literal>).
+This tool is a part of the &t-link-gettext; toolset.
+It provides &SCons;
+an interface to the <command>msgfmt(1)</command> command
+by setting up the &b-link-MOFiles; builder,
+which generates binary message catalog (<literal>MO</literal>) files
+from a textual translation description
+(<literal>PO</literal> files).
</para>
<para>Sets: &cv-link-MOSUFFIX;, &cv-link-MSGFMT;, &cv-link-MSGFMTCOM;, &cv-link-MSGFMTCOMSTR;, &cv-link-MSGFMTFLAGS;, &cv-link-POSUFFIX;.</para><para>Uses: &cv-link-LINGUAS_FILE;.</para></listitem>
</varlistentry>
<varlistentry id="t-msginit">
<term>msginit</term>
<listitem><para>
-This scons tool is a part of scons &t-link-gettext; toolset. It provides
-scons interface to <command>msginit(1)</command> program, which creates new
+This tool is a part of scons &t-link-gettext; toolset. It provides
+&SCons; an interface to the <command>msginit(1)</command> program,
+by setting up the &b-link-POInit; builder,
+which creates a new
<literal>PO</literal> file, initializing the meta information with values from
-user's environment (or options).
+the &consenv; (or options).
</para>
<para>Sets: &cv-link-MSGINIT;, &cv-link-MSGINITCOM;, &cv-link-MSGINITCOMSTR;, &cv-link-MSGINITFLAGS;, &cv-link-POAUTOINIT;, &cv-link-POCREATE_ALIAS;, &cv-link-POSUFFIX;, &cv-link-POTSUFFIX;, &cv-link-_MSGINITLOCALE;.</para><para>Uses: &cv-link-LINGUAS_FILE;, &cv-link-POAUTOINIT;, &cv-link-POTDOMAIN;.</para></listitem>
</varlistentry>
<varlistentry id="t-msgmerge">
<term>msgmerge</term>
<listitem><para>
-This scons tool is a part of scons &t-link-gettext; toolset. It provides
-scons interface to <command>msgmerge(1)</command> command, which merges two
+This tool is a part of scons &t-link-gettext; toolset. It provides
+&SCons; an interface to the <command>msgmerge(1)</command> command,
+by setting up the &b-link-POUpdate; builder,
+which merges two
Uniform style <filename>.po</filename> files together.
</para>
<para>Sets: &cv-link-MSGMERGE;, &cv-link-MSGMERGECOM;, &cv-link-MSGMERGECOMSTR;, &cv-link-MSGMERGEFLAGS;, &cv-link-POSUFFIX;, &cv-link-POTSUFFIX;, &cv-link-POUPDATE_ALIAS;.</para><para>Uses: &cv-link-LINGUAS_FILE;, &cv-link-POAUTOINIT;, &cv-link-POTDOMAIN;.</para></listitem>
@@ -921,7 +928,7 @@ The &t-qt3; tool supports the following operations:
<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
+the same basename as your implementation file and must stay in the same
directory. It must have one of the suffixes
<filename>.h</filename>,
<filename>.hpp</filename>,
@@ -1085,18 +1092,18 @@ Set &consvars; for the &b-link-Textfile; and &b-link-Substfile; builders.
<varlistentry id="t-tlib">
<term>tlib</term>
<listitem><para>
-Sets construction variables for the Borlan
-<application>tib</application> library archiver.
+Sets construction variables for the Borland
+<application>tlib</application> library archiver.
</para>
<para>Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.</para><para>Uses: &cv-link-ARCOMSTR;.</para></listitem>
</varlistentry>
<varlistentry id="t-xgettext">
<term>xgettext</term>
<listitem><para>
-This scons tool is a part of scons &t-link-gettext; toolset. It provides
-scons interface to <command>xgettext(1)</command>
-program, which extracts internationalized messages from source code. The tool
-provides &b-POTUpdate; builder to make <literal>PO</literal>
+This tool is a part of the &t-link-gettext; toolset. It provides
+&SCons; an interface to the <command>xgettext(1)</command>
+program, which extracts internationalized messages from source code.
+The tool sets up the &b-POTUpdate; builder to make <literal>PO</literal>
<emphasis>Template</emphasis> files.
</para>
<para>Sets: &cv-link-POTSUFFIX;, &cv-link-POTUPDATE_ALIAS;, &cv-link-XGETTEXTCOM;, &cv-link-XGETTEXTCOMSTR;, &cv-link-XGETTEXTFLAGS;, &cv-link-XGETTEXTFROM;, &cv-link-XGETTEXTFROMPREFIX;, &cv-link-XGETTEXTFROMSUFFIX;, &cv-link-XGETTEXTPATH;, &cv-link-XGETTEXTPATHPREFIX;, &cv-link-XGETTEXTPATHSUFFIX;, &cv-link-_XGETTEXTDOMAIN;, &cv-link-_XGETTEXTFROMFLAGS;, &cv-link-_XGETTEXTPATHFLAGS;.</para><para>Uses: &cv-link-POTDOMAIN;.</para></listitem>
diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen
index 26371cf..8383f2c 100644
--- a/doc/generated/variables.gen
+++ b/doc/generated/variables.gen
@@ -18,7 +18,7 @@
</term>
<listitem><para>
This construction variable automatically introduces &cv-link-_LDMODULEVERSIONFLAGS;
-if &cv-link-LDMODULEVERSION; is set. Othervise it evaluates to an empty string.
+if &cv-link-LDMODULEVERSION; is set. Otherwise, it evaluates to an empty string.
</para>
</listitem>
</varlistentry>
@@ -28,7 +28,7 @@ if &cv-link-LDMODULEVERSION; is set. Othervise it evaluates to an empty string.
</term>
<listitem><para>
This construction variable automatically introduces &cv-link-_SHLIBVERSIONFLAGS;
-if &cv-link-SHLIBVERSION; is set. Othervise it evaluates to an empty string.
+if &cv-link-SHLIBVERSION; is set. Otherwise, it evaluates to an empty string.
</para>
</listitem>
</varlistentry>
@@ -560,7 +560,7 @@ after the SCons template for the file has been written.
</term>
<listitem><para>
A reserved variable name
-that may not be set or used in a construction environment.
+that may not be set or used in a &consenv;.
(See the manpage section "Variable Substitution"
for more information).
</para>
@@ -572,7 +572,7 @@ for more information).
</term>
<listitem><para>
A reserved variable name
-that may not be set or used in a construction environment.
+that may not be set or used in a &consenv;.
(See the manpage section "Variable Substitution"
for more information).
</para>
@@ -763,7 +763,7 @@ and the second is the macro definition.
If the definition is not omitted or <literal>None</literal>,
the name and definition are combined into a single
<literal>name=definition</literal> item
-before the preending/appending.
+before the prepending/appending.
</para>
<example_commands>
@@ -912,7 +912,7 @@ to each directory in &cv-link-CPPPATH;.
The list of directories that the C preprocessor will search for include
directories. The C/C++ implicit dependency scanner will search these
directories for include files.
-In general it's not advised to put include directory directives
+In general, it's not advised to put include directory directives
directly into &cv-link-CCFLAGS; or &cv-link-CXXFLAGS;
as the result will be non-portable
and the directories will not be searched by the dependency scanner.
@@ -927,7 +927,7 @@ 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;
-to look-up a directory relative to the root of the source tree use
+to lookup a directory relative to the root of the source tree, use
the <literal>#</literal> prefix:
</para>
@@ -936,7 +936,7 @@ env = Environment(CPPPATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&f-link-Dir;
function:
</para>
@@ -990,7 +990,7 @@ The default list is:
</term>
<listitem><para>
The C++ compiler.
-See also &cv-link-SHCXX; for compiling to shared objects..
+See also &cv-link-SHCXX; for compiling to shared objects.
</para>
</listitem>
</varlistentry>
@@ -1003,7 +1003,7 @@ The command line used to compile a C++ source file to an object file.
Any options specified in the &cv-link-CXXFLAGS; and
&cv-link-CPPFLAGS; construction variables
are included on this command line.
-See also &cv-link-SHCXXCOM; for compiling to shared objects..
+See also &cv-link-SHCXXCOM; for compiling to shared objects.
</para>
</listitem>
</varlistentry>
@@ -1015,7 +1015,7 @@ See also &cv-link-SHCXXCOM; for compiling to shared objects..
If set, the string displayed when a C++ source file
is compiled to a (static) object file.
If not set, then &cv-link-CXXCOM; (the command line) is displayed.
-See also &cv-link-SHCXXCOMSTR; for compiling to shared objects..
+See also &cv-link-SHCXXCOMSTR; for compiling to shared objects.
</para>
<example_commands>
@@ -1042,7 +1042,7 @@ and
as C++ files,
and files with
<filename>.mm</filename>
-suffixes as Objective C++ files.
+suffixes as Objective-C++ files.
On case-sensitive systems (Linux, UNIX, and other POSIX-alikes),
SCons also treats
<filename>.C</filename>
@@ -1061,7 +1061,7 @@ By default, this includes the value of &cv-link-CCFLAGS;,
so that setting &cv-CCFLAGS; affects both C and C++ compilation.
If you want to add C++-specific flags,
you must set or override the value of &cv-link-CXXFLAGS;.
-See also &cv-link-SHCXXFLAGS; for compiling to shared objects..
+See also &cv-link-SHCXXFLAGS; for compiling to shared objects.
</para>
</listitem>
</varlistentry>
@@ -1509,7 +1509,7 @@ The string displayed when a renderer like <literal>fop</literal> or
<envar>DOCBOOK_FOPFLAGS</envar>
</term>
<listitem><para>
-Additonal command-line flags for the
+Additional command-line flags for the
PDF renderer <literal>fop</literal> or <literal>xep</literal>.
</para>
</listitem>
@@ -1551,7 +1551,7 @@ XIncludes for a given XML file.
<envar>DOCBOOK_XMLLINTFLAGS</envar>
</term>
<listitem><para>
-Additonal command-line flags for the external executable
+Additional command-line flags for the external executable
<literal>xmllint</literal>.
</para>
</listitem>
@@ -1595,7 +1595,7 @@ an XML file via a given XSLT stylesheet.
<envar>DOCBOOK_XSLTPROCFLAGS</envar>
</term>
<listitem><para>
-Additonal command-line flags for the external executable
+Additional command-line flags for the external executable
<literal>xsltproc</literal> (or <literal>saxon</literal>,
<literal>xalan</literal>).
</para>
@@ -1606,7 +1606,7 @@ Additonal command-line flags for the external executable
<envar>DOCBOOK_XSLTPROCPARAMS</envar>
</term>
<listitem><para>
-Additonal parameters that are not intended for the XSLT processor executable, but
+Additional parameters that are not intended for the XSLT processor executable, but
the XSL processing itself. By default, they get appended at the end of the command line
for <literal>saxon</literal> and <literal>saxon-xslt</literal>, respectively.
</para>
@@ -1907,7 +1907,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F03PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F03PATH; if you need to define a specific
include path for Fortran 03 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -1921,7 +1921,7 @@ env = Environment(F03PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
@@ -2095,7 +2095,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F08PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F08PATH; if you need to define a specific
include path for Fortran 08 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -2109,7 +2109,7 @@ env = Environment(F08PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
@@ -2283,7 +2283,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F77PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F77PATH; if you need to define a specific
include path for Fortran 77 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -2297,7 +2297,7 @@ env = Environment(F77PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
@@ -2471,7 +2471,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F90PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F90PATH; if you need to define a specific
include path for Fortran 90 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -2485,7 +2485,7 @@ env = Environment(F90PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
@@ -2658,7 +2658,7 @@ and the directories will not be searched by the dependency scanner. Note:
directory names in &cv-link-F95PATH; 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 lookup a directory relative to the root of the source tree, use #:
You only need to set &cv-link-F95PATH; if you need to define a specific
include path for Fortran 95 files.
You should normally set the &cv-link-FORTRANPATH; variable,
@@ -2672,7 +2672,7 @@ env = Environment(F95PATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
@@ -2962,7 +2962,7 @@ non-portable and the directories will not be searched by the dependency
scanner. Note: directory names in FORTRANPATH 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 lookup a directory relative to the root of the source tree, use #:
</para>
<example_commands>
@@ -3365,9 +3365,9 @@ greater than one, as that has a different meaning).
<para>
Action strings can be segmented by the
use of an AND operator, <literal>&amp;&amp;</literal>.
-In a segemented string, each segment is a separate
+In a segmented string, each segment is a separate
<quote>command line</quote>, these are run
-sequentially until one fails or the entire
+sequentially until one fails, or the entire
sequence has been executed. If an
action string is segmented, then the selected
behavior of &cv-IMPLICIT_COMMAND_DEPENDENCIES;
@@ -3559,7 +3559,7 @@ env = Environment(JARCOMSTR="JARchiving $SOURCES into $TARGET")
</term>
<listitem><para>
General options passed to the Java archive tool.
-By default this is set to
+By default, this is set to
<option>cf</option>
to create the necessary
<command>jar</command>
@@ -3881,7 +3881,7 @@ for Java classes.
that &SCons; expects will be generated by the &javac; compiler.
Setting &cv-JAVAVERSION; to a version greater than
<literal>1.4</literal> makes &SCons; realize that a build
- with such a compiler is actually up to date.
+ with such a compiler is actually up-to-date.
The default is <literal>1.4</literal>.
</para>
<para>
@@ -4196,7 +4196,7 @@ by &SCons; in all situations. Consider using
<envar>LEXUNISTD</envar>
</term>
<listitem><para>
-Used only on windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'.
+Used only in Windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'.
</para>
</listitem>
</varlistentry>
@@ -4362,7 +4362,7 @@ directory names in &cv-LIBPATH; will be looked-up relative to the
directory of the SConscript file
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 lookup a directory relative to the root of the source tree, use
the <literal>#</literal> prefix:
</para>
@@ -4371,7 +4371,7 @@ env = Environment(LIBPATH='#/libs')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&f-link-Dir; function:
</para>
@@ -4461,7 +4461,7 @@ If &cv-link-LIBLITERALPREFIX; is set to a non-empty string,
then a string-valued &cv-LIBS; entry
that starts with &cv-link-LIBLITERALPREFIX;
will cause the rest of the entry
-to be searched for for unmodified,
+to be searched for unmodified,
but respecting normal library search paths
(this is an exception to the guideline above
about leaving off the prefix/suffix from the library name).
@@ -4492,12 +4492,12 @@ env.Append(LIBS=File('/tmp/mylib.so'))
<!-- is this actually true? -->
For each &Builder; call that causes linking with libraries,
&SCons; will add the libraries in the setting of &cv-LIBS;
-in effect at that moment to the dependecy graph
+in effect at that moment to the dependency graph
as dependencies of the target being generated.
</para>
<para>
-The library list will transformed to command line
+The library list will be transformed to command-line
arguments through the automatically-generated
&cv-link-_LIBFLAGS; &consvar;
which is constructed by
@@ -4581,10 +4581,10 @@ It defaults to the current system line separator.
The &cv-LINGUAS_FILE; defines file(s) containing list of additional linguas
to be processed by &b-link-POInit;, &b-link-POUpdate; or &b-link-MOFiles;
builders. It also affects &b-link-Translate; builder. If the variable contains
-a string, it defines name of the list file. The &cv-LINGUAS_FILE; may be a
+a string, it defines the name of the list file. The &cv-LINGUAS_FILE; may be a
list of file names as well. If &cv-LINGUAS_FILE; is set to
-<literal>True</literal> (or non-zero numeric value), the list will be read from
-default file named
+a non-string truthy value, the list will be read from
+the file named
<filename>LINGUAS</filename>.
</para>
@@ -4852,7 +4852,7 @@ See &t-link-msgfmt; tool and &b-link-MOFiles; builder.
</term>
<listitem><para>
Path to <command>msginit(1)</command> program (found via
-<literal>Detect()</literal>).
+&f-link-Detect;).
See &t-link-msginit; tool and &b-link-POInit; builder.
</para>
</listitem>
@@ -4872,8 +4872,9 @@ See &t-link-msginit; tool and &b-link-POInit; builder.
<envar>MSGINITCOMSTR</envar>
</term>
<listitem><para>
-String to display when <command>msginit(1)</command> is invoked
-(default: <literal>''</literal>, which means ``print &cv-link-MSGINITCOM;'').
+String to display when <command>msginit(1)</command> is invoked.
+The default is an empty string,
+which will print the command line (&cv-link-MSGINITCOM;).
See &t-link-msginit; tool and &b-link-POInit; builder.
</para>
</listitem>
@@ -4928,8 +4929,9 @@ See &t-link-msgmerge; tool and &b-link-POUpdate; builder.
<envar>MSGMERGECOMSTR</envar>
</term>
<listitem><para>
-String to be displayed when <command>msgmerge(1)</command> is invoked
-(default: <literal>''</literal>, which means ``print &cv-link-MSGMERGECOM;'').
+String to be displayed when <command>msgmerge(1)</command> is invoked.
+The default is an empty string,
+which will print the command line (&cv-link-MSGMERGECOM;).
See &t-link-msgmerge; tool and &b-link-POUpdate; builder.
</para>
</listitem>
@@ -6206,7 +6208,7 @@ Visual Studio </literallayout></entry>
It is only necessary to specify the <literal>Exp</literal>
suffix to select the express edition when both express and
non-express editions of the same product are installed
- simulaneously. The <literal>Exp</literal> suffix is unnecessary,
+ simultaneously. The <literal>Exp</literal> suffix is unnecessary,
but accepted, when only the express edition is installed.
</para></listitem>
</itemizedlist>
@@ -6368,7 +6370,7 @@ and &cv-link-MSVC_USE_SETTINGS;.
<literal>SccProjectFilePathRelativizedFromConnection[i]</literal>
(where [i] ranges from 0 to the number of projects in the solution)
attributes of the <literal>GlobalSection(SourceCodeControl)</literal>
- section of the Microsoft Visual Studio solution file. Similarly
+ section of the Microsoft Visual Studio solution file. Similarly,
the relative solution file path is placed as the values of the
<literal>SccLocalPath[i]</literal> (where [i] ranges from 0
to the number of projects in the solution) attributes of the
@@ -6433,7 +6435,7 @@ and &cv-link-MSVC_USE_SETTINGS;.
and &cv-MSVC_VERSION; is not,
&cv-MSVC_VERSION; will be initialized to the value
of &cv-MSVS_VERSION;.
- An error is raised if If both are set and have different values,
+ An error is raised if both are set and have different values.
</para>
</listitem>
</varlistentry>
@@ -6759,7 +6761,7 @@ scons NINJA_CMD_ARGS="-v -j 3"
<envar>NINJA_FORCE_SCONS_BUILD</envar>
</term>
<listitem><para>
- If true, causes the build nodes to callback to scons instead of using
+ If true, causes the build nodes to call back to scons instead of using
&ninja; to build them. This is intended to be passed to the environment on the builder invocation.
It is useful if you have a build node which does something which is not easily translated into &ninja;.
</para>
@@ -6829,7 +6831,7 @@ scons NINJA_CMD_ARGS="-v -j 3"
</term>
<listitem><para>
Internal value used to specify the function to call with argument env to generate the list of files
- which if changed would require the &ninja; build file to be regenerated.
+ which, if changed, would require the &ninja; build file to be regenerated.
</para>
</listitem>
</varlistentry>
@@ -6838,7 +6840,7 @@ scons NINJA_CMD_ARGS="-v -j 3"
<envar>NINJA_SCONS_DAEMON_KEEP_ALIVE</envar>
</term>
<listitem><para>
- The number of seconds for the SCons deamon launched by ninja to stay alive.
+ The number of seconds for the SCons daemon launched by ninja to stay alive.
(Default: 180000)
</para>
</listitem>
@@ -6916,7 +6918,7 @@ placed if applicable. The default value is <quote>&cv-NAME;-&cv-VERSION;</quote
</term>
<listitem><para>
Selects the package type to build when using the &b-link-Package;
-builder. May be a string or list of strings. See the docuentation
+builder. It may be a string or list of strings. See the documentation
for the builder for the currently supported types.
</para>
@@ -7000,7 +7002,7 @@ only if the &cv-link-PDB; &consvar; is set.
<listitem><para>
This variable specifies how much of a source file is precompiled. This
variable is ignored by tools other than &MSVC;, or when
-the PCH variable is not being used. When this variable is define it
+the PCH variable is not being used. When this variable is defined, it
must be a string that is the name of the header that
is included at the end of the precompiled portion of the source files, or
the empty string if the "#pragma hrdstop" construct is being used:
@@ -8294,7 +8296,7 @@ See also &cv-link-CXXFLAGS; for compiling to static objects.
</term>
<listitem><para>
The name of the compiler to use when compiling D source
-destined to be in a shared objects.
+destined to be in a shared object.
See also &cv-link-DC; for compiling to static objects.
</para>
</listitem>
@@ -9006,7 +9008,7 @@ When this &consvar; is defined, a versioned shared library
is created by the &b-link-SharedLibrary; builder. This activates the
&cv-link-_SHLIBVERSIONFLAGS; and thus modifies the &cv-link-SHLINKCOM; as
required, adds the version number to the library name, and creates the symlinks
-that are needed. &cv-link-SHLIBVERSION; versions should exist as alpha-numeric,
+that are needed. &cv-link-SHLIBVERSION; versions should exist as alphanumeric,
decimal-delimited values as defined by the regular expression "\w+[\.\w+]*".
Example &cv-link-SHLIBVERSION; values include '1', '1.2.3', and '1.2.gitaa412c8b'.
</para>
@@ -9146,7 +9148,7 @@ The variable is used, for example, by &t-link-gnulink; linker tool.
</term>
<listitem><para>
A reserved variable name
-that may not be set or used in a construction environment.
+that may not be set or used in a &consenv;.
(See the manpage section "Variable Substitution"
for more information).
</para>
@@ -9173,7 +9175,7 @@ field in the controlling information for Ipkg and RPM packages.
</term>
<listitem><para>
A reserved variable name
-that may not be set or used in a construction environment.
+that may not be set or used in a &consenv;.
(See the manpage section "Variable Substitution"
for more information).
</para>
@@ -9458,7 +9460,7 @@ 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 lookup a directory relative to the root of the source tree, use
a top-relative path (<literal>#</literal>):
</para>
@@ -9467,7 +9469,7 @@ env = Environment(SWIGPATH='#/include')
</example_commands>
<para>
-The directory look-up can also be forced using the
+The directory lookup can also be forced using the
&Dir;()
function:
</para>
@@ -9555,7 +9557,7 @@ General options passed to the tar archiver.
</term>
<listitem><para>
A reserved variable name
-that may not be set or used in a construction environment.
+that may not be set or used in a &consenv;.
(See the manpage section "Variable Substitution"
for more information).
</para>
@@ -9631,7 +9633,7 @@ for more information).
</term>
<listitem><para>
A reserved variable name
-that may not be set or used in a construction environment.
+that may not be set or used in a &consenv;.
(See the manpage section "Variable Substitution"
for more information).
</para>
@@ -9885,7 +9887,7 @@ The value is informative and is not guaranteed to be complete.
</term>
<listitem><para>
A reserved variable name
-that may not be set or used in a construction environment.
+that may not be set or used in a &consenv;.
(See the manpage section "Variable Substitution"
for more information).
</para>
@@ -9897,7 +9899,7 @@ for more information).
</term>
<listitem><para>
A reserved variable name
-that may not be set or used in a construction environment.
+that may not be set or used in a &consenv;.
(See the manpage section "Variable Substitution"
for more information).
</para>
@@ -10362,7 +10364,7 @@ field in the RPM
<envar>X_RPM_EXTRADEFS</envar>
</term>
<listitem><para>
-A list used to supply extra defintions or flags
+A list used to supply extra definitions or flags
to be added to the RPM <filename>.spec</filename> file.
Each item is added as-is with a carriage return appended.
This is useful if some specific RPM feature not otherwise
@@ -10643,7 +10645,7 @@ See &t-link-xgettext; tool and &b-link-POTUpdate; builder.
<envar>_XGETTEXTFROMFLAGS</envar>
</term>
<listitem><para>
-Internal "macro". Genrates list of <literal>-D&lt;dir&gt;</literal> flags
+Internal "macro". Generates list of <literal>-D&lt;dir&gt;</literal> flags
from the &cv-link-XGETTEXTPATH; list.
</para>
</listitem>
@@ -10654,7 +10656,7 @@ from the &cv-link-XGETTEXTPATH; list.
</term>
<listitem><para>
This flag is used to add single &cv-link-XGETTEXTFROM; file to
-<command>xgettext(1)</command>'s commandline (default:
+<command>xgettext(1)</command>'s command line (default:
<literal>'-f'</literal>).
</para>
</listitem>
@@ -10698,7 +10700,7 @@ from &cv-link-XGETTEXTFROM;.
</term>
<listitem><para>
This flag is used to add single search path to
-<command>xgettext(1)</command>'s commandline (default:
+<command>xgettext(1)</command>'s command line (default:
<literal>'-D'</literal>).
</para>
</listitem>
@@ -11010,7 +11012,7 @@ General options passed to the zip utility.
<listitem><para>
An optional zip root directory (default empty). The filenames stored
in the zip file will be relative to this directory, if given.
-Otherwise the filenames are relative to the current directory of the
+Otherwise, the filenames are relative to the current directory of the
command.
For instance:
</para>
diff --git a/doc/man/scons-time.xml b/doc/man/scons-time.xml
index 794e593..2ce8c3b 100644
--- a/doc/man/scons-time.xml
+++ b/doc/man/scons-time.xml
@@ -41,7 +41,7 @@
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
- <command>scons-time</command>
+ <command>scons-time</command>
<arg choice='plain'><replaceable>subcommand</replaceable></arg>
<arg choice='opt' rep='repeat'><replaceable>options</replaceable></arg>
<arg choice='opt' rep='repeat'><replaceable>arguments</replaceable></arg>
@@ -129,7 +129,7 @@
</refsect1>
<refsect1 id='description'><title>DESCRIPTION</title>
-<para>The
+<para>The
<command>scons-time</command>
command runs an SCons configuration
through a standard set of profiled timings
@@ -703,7 +703,7 @@ and processing the SConscript files.</para>
<term>Full build</term>
<listitem>
<para>SCons is run to build everything specified in the configuration.
-Specific targets to be passed in on the command l ine
+Specific targets to be passed in on the command line
may be specified by the
<emphasis role="bold">targets</emphasis>
keyword in a configuration file; see below for details.</para>
@@ -800,7 +800,7 @@ if the first argument is a directory,
the default prefix is the name of the directory;
if the first argument is an archive
(tar or zip file),
-the default prefix is the the base name of the archive,
+the default prefix is the base name of the archive,
that is, what remains after stripping the archive suffix
(<markup>.tgz</markup>, <markup>.tar.gz</markup> or <markup>.zip</markup>).</para>
</listitem>
@@ -984,7 +984,7 @@ value:
<emphasis role="bold">SConscripts</emphasis>
(total execution time for the SConscript files themselves),
<emphasis role="bold">SCons</emphasis>
-(exectuion time in SCons code itself)
+(execution time in SCons code itself)
or
<emphasis role="bold">commands</emphasis>
(execution time of the commands and other actions
@@ -1169,7 +1169,7 @@ arguments = ['project-1.2.tgz', 'project-SConscripts.tar']
# so tell scons-time to chdir there before building.
subdir = 'project-1.2'
-# Set the prefix so output log files and profiles are named:
+# Set the prefix, so output log files and profiles are named:
# project-000-[012].{log,prof}
# project-001-[012].{log,prof}
# etc.
diff --git a/doc/man/scons.xml b/doc/man/scons.xml
index 022f44c..0193924 100644
--- a/doc/man/scons.xml
+++ b/doc/man/scons.xml
@@ -138,7 +138,7 @@ to support additional input file types.
<para>Information about files involved in the build,
including a cryptographic hash of the contents of source files,
is cached for later reuse.
-By default this hash (the <firstterm>&contentsig;</firstterm>)
+By default, this hash (the <firstterm>&contentsig;</firstterm>)
is used to decide if a file has changed since the last build,
although other algorithms can be used by selecting an appropriate
<firstterm>&f-link-Decider;</firstterm> function.
@@ -172,7 +172,7 @@ The file is by default named &SConstruct;,
although some variants of that,
or a developer-chosen name, are also accepted
(see <xref linkend="sconscript_files"/>).
-If found, the currrent directory
+If found, the current directory
is set as the project top directory.
Certain command-line options specify alternate
places to look for &SConstruct;
@@ -284,7 +284,7 @@ To assure reproducible builds,
&SCons;
uses a restricted <firstterm>execution environment</firstterm>
for running external commands used to build targets,
-rather then propagating the full environment
+rather than propagating the full environment
in effect at the time &scons; was called.
This helps avoid problems like picking up accidental
or malicious settings,
@@ -298,7 +298,7 @@ either by assigning the desired values,
or by picking those values individually or collectively
out of environment variables exposed by the &Python;
<systemitem>os.environ</systemitem> dictionary
-(as external program inputs they should be validate
+(as external program inputs they should be validated
before use).
The execution environment for a given &consenv;
is its &cv-link-ENV; value.
@@ -476,10 +476,10 @@ searches in order
for the GCC tool chain,
the LLVM/clang tools,
and the Intel compiler tools.
-The defaul tool selection can be pre-empted
+The default tool selection can be pre-empted
through the use of the <parameter>tools</parameter>
argument to &consenv; creation methods,
-explcitly calling the &f-link-Tool; loader,
+explicitly calling the &f-link-Tool; loader,
the through the setting of various setting of &consvars;.
</para>
@@ -757,7 +757,7 @@ built during this invocation.
<varlistentry id="opt-cache-show">
<term><option>--cache-show</option></term>
<listitem>
-<para>When using a derived-file cache show the command
+<para>When using a derived-file cache, show the command
that would have been executed to build the file
(or the corresponding <literal>*COMSTR</literal>
contents if set)
@@ -789,7 +789,7 @@ This saves time by not running the same configuration tests
every time you invoke scons,
but will overlook changes in system header files
or external commands (such as compilers)
-if you don't specify those dependecies explicitly.
+if you don't specify those dependencies explicitly.
This is the default behavior.</para>
</listitem>
</varlistentry>
@@ -800,7 +800,7 @@ This is the default behavior.</para>
<para>If this mode is specified,
all configuration tests will be re-run
regardless of whether the
-cached results are out of date.
+cached results are out-of-date.
This can be used to explicitly
force the configuration tests to be updated
in response to an otherwise unconfigured change
@@ -1067,7 +1067,7 @@ without requiring <filename>.py</filename> suffix.
is prepared for building.
&scons;
prints this for each target it considers, even if that
-target is up to date (see also <option>--debug=explain</option>).
+target is up-to-date (see also <option>--debug=explain</option>).
This can help debug problems with targets that aren't being
built; it shows whether
&scons;
@@ -1341,7 +1341,7 @@ to use the specified algorithm.</para>
<para>If this option is omitted,
the first supported hash format found is selected.
-Typically this is MD5, however, on a FIPS-compliant system
+Typically, this is MD5, however, on a FIPS-compliant system
using a version of &Python; older than 3.9,
SHA1 or SHA256 is chosen as the default.
&Python; 3.9 and onwards clients always default to MD5, even in FIPS mode.
@@ -1629,7 +1629,7 @@ scons&gt;&gt;&gt; exit
<option>--jobs=<replaceable>N</replaceable></option>
</term>
<listitem>
-<para>Specifies the maximum number of comcurrent jobs (commands) to run.
+<para>Specifies the maximum number of concurrent jobs (commands) to run.
If there is more than one
<option>-j</option>
option, the last one is effective.</para>
@@ -1752,7 +1752,7 @@ if not GetOption("no_exec"):
determine what would be built. For example, if a file generated
by a builder action is also used as a source in the build,
that file is not available to scan for dependencies at all
-in an unbuilt tree, and may contain out of date information in a
+in an unbuilt tree, and may contain out-of-date information in a
previously built tree.
</para>
<para>
@@ -1760,7 +1760,7 @@ previously built tree.
as they would make changes to the filesystem
(see &cv-link-CONFIGUREDIR; and &cv-link-CONFIGURELOG;).
It can use stored information from a previous build,
-if it is not out of date,
+if it is not out-of-date,
so a "priming" build may make subsequent no-exec runs
more useful.
</para>
@@ -1779,7 +1779,7 @@ added to the module search path <varname>sys.path</varname>,
searched for a <filename>site_init.py</filename> file,
or have their <filename>site_tools</filename>
directory included in the tool search path.
-Can be overridden by a subequent
+Can be overridden by a subsequent
<option>--site-dir</option> option.
</para>
</listitem>
@@ -1845,8 +1845,8 @@ The results may be analyzed using the &Python;
<option>--question</option></term>
<listitem>
<para>Do not run any commands, or print anything. Just return an exit
-status that is zero if the specified targets are already up to
-date, non-zero otherwise.</para>
+status that is zero if the specified targets are already up-to-date,
+non-zero otherwise.</para>
</listitem>
</varlistentry>
@@ -2368,7 +2368,7 @@ is run with the &Python;
option or from optimized &Python; (<filename>.pyo</filename>) modules.</para>
<para>
Note the "no-" prefix is part of the name of this warning.
-Add an additional "-no" to disable.
+Add another "-no" to disable.
</para>
</listitem>
</varlistentry>
@@ -2383,7 +2383,7 @@ option is used.
These warnings are enabled by default.</para>
<para>
Note the "no-" prefix is part of the name of this warning.
-Add an additional "-no" to disable.
+Add another "-no" to disable.
</para>
</listitem>
</varlistentry>
@@ -2512,7 +2512,7 @@ the build don't accidentally step on each other.
You have to be explicit about sharing information,
by using the &f-link-Export; function or the &exports; argument
to the &f-link-SConscript; function, as well as the &f-link-Return; function
-in a called &SConscript; file, and comsume shared information by using the
+in a called &SConscript; file, and consume shared information by using the
&f-link-Import; function.
</para>
@@ -2562,8 +2562,8 @@ env['FOO'] = 'foo'
<!--TODO: how can the user tell which settings are init-only? -->
<para>Note that certain settings which affect tool detection are
-referenced only when the tools are initializided,
-so you either need either to supply them as part of the call to
+referenced only when the tools are initialized,
+so you need either to supply them as part of the call to
&f-link-Environment;, or defer tool initialization.
For example, initializing the &MSVC; version you wish to use:
</para>
@@ -2667,7 +2667,7 @@ one of the pre-defined platforms
<literal>posix</literal>,
<literal>sunos</literal> or
<literal>win32</literal>),
-or it may be be a callable platform object
+or a callable platform object
returned by a call to &f-link-Platform;
selecting a pre-defined platform,
or it may be a user-supplied callable,
@@ -2684,7 +2684,7 @@ env = Environment(platform=my_platform)
<para>
Note that supplying a non-default platform or custom
-fuction for initialization
+function for initialization
may bypass settings that should happen for the host system
and should be used with care.
It is most useful in the case where the platform is an alternative for
@@ -2718,7 +2718,7 @@ See <xref linkend="commandline_construction_variables"/> for details.
which are used to help initialize the &consenv; prior to building,
and more can be written to suit a particular purpose,
or added from external sources (a repository of
-constributed tools is available).
+contributed tools is available).
More information on writing custom tools can be found in the
<link linkend='extending_scons'>Extending SCons</link> section
and specifically <link linkend='tool_modules'>Tool Modules</link>.
@@ -2827,7 +2827,7 @@ specified relationship into its internal dependency node graph,
and only later makes the decision on whether anything is actually built,
since this depends on command-line options,
target selection rules, and whether the target(s) are
-out of date with respect to the sources.
+out-of-date with respect to the sources.
</para>
<para>
@@ -2920,7 +2920,7 @@ of the &SConscript; file currently being processed.
&SCons; also recognizes a third way to specify
path strings: if the string begins with
the <emphasis role="bold">#</emphasis> character it is
-<firstterm>top-relative</firstterm> - it works like a relative path but the
+<firstterm>top-relative</firstterm> - it works like a relative path, but the
search follows down from the project top directory rather than
from the current directory. The <emphasis role="bold">#</emphasis>
can optionally be followed by a pathname separator,
@@ -3273,7 +3273,7 @@ object_files.extend(Object('bar.c'))
</programlisting>
<para>The path name for a Node's file may be used
-by passing the Node to &Python;'s builtin
+by passing the Node to &Python;'s built-in
<function>str</function>
function:</para>
@@ -3601,7 +3601,7 @@ selects for building as a result of making the sure the
specified targets are up to date, if those targets
did not appear on the command line.
The list is empty if neither
-command line targets or &Default; calls are present.
+command line targets nor &Default; calls are present.
</para>
<para>
The elements of this list may be strings
@@ -3638,10 +3638,10 @@ the command line. If there are command line targets,
this list has the same contents as
<link linkend="v-BUILD_TARGETS">&BUILD_TARGETS;</link>.
If there are no targets specified on the command line,
-the list is empty. The elements of this list are strings.
+this list is empty. The elements of this list are strings.
This can be used, for example,
to take specific actions only
-when a certain targets is explicitly requested for building.</para>
+when a certain target(s) are explicitly requested for building.</para>
<para>Example:</para>
@@ -3679,7 +3679,7 @@ if 'foo' in [str(t) for t in DEFAULT_TARGETS]:
<para>The contents of the
&DEFAULT_TARGETS;
-list change on on each successive call to the
+list changes on each successive call to the
&Default; function:</para>
<programlisting language="python">
@@ -3887,7 +3887,7 @@ The mechanism is portable across platforms.
does not maintain an explicit cache of the tested values
(this is different than &Autoconf;),
but uses its normal dependency tracking to keep the checked values
-up to date. However, users may override this behaviour with the
+up to date. However, users may override this behavior with the
<link linkend="opt-config"><option>--config</option></link>
command line option.</para>
@@ -4234,7 +4234,7 @@ header files whose
lines should precede the
header line being checked for.
A code fragment
-(must be a a valid expression, including a trailing semicolon)
+(must be a valid expression, including a trailing semicolon)
to serve as the test can be supplied in
<parameter>call</parameter>;
if not supplied,
@@ -4558,7 +4558,7 @@ can make use of::</para>
<listitem>
<para>Displays <parameter>text</parameter>
-as an indicator of progess.
+as an indicator of progress.
For example: <computeroutput>Checking for library X...</computeroutput>.
Usually called before the check is started.
</para>
@@ -4788,8 +4788,8 @@ The key-value pairs from <parameter>args</parameter>
will be added to those obtained from
<parameter>files</parameter>, if any.
Keys from <parameter>args</parameter>
-take precendence over same-named keys from <parameter>files</parameter>.
-If omittted, the default is the
+take precedence over same-named keys from <parameter>files</parameter>.
+If omitted, the default is the
<link linkend="v-ARGUMENTS">&ARGUMENTS;</link>
dictionary that holds build variables
specified on the command line.
@@ -5142,7 +5142,7 @@ vars.FormatVariableHelpText = my_format
<para>
&SCons; provides five pre-defined variable types,
-acessible through factory functions that generate
+accessible through factory functions that generate
a tuple appropriate for directly passing to the
<link linkend='v-Add'><function>Add</function></link>
<link linkend='v-AddVariables'><function>AddVariables</function></link>
@@ -5326,7 +5326,7 @@ specifies the descriptive part of the help text.
<listitem>
<para>
Set up a variable named <parameter>key</parameter> to hold a path string.
-The variable will have have a default value of
+The variable will have a default value of
<parameter>default</parameter>,
and the <parameter>help</parameter> parameter
will be used as the descriptive part of the help text.
@@ -5421,7 +5421,7 @@ vars.AddVariables(
default="no",
allowed_values=("yes", "no", "full"),
map={},
- ignorecase=0, # case sensitive
+ ignorecase=0, # case-sensitive
),
ListVariable(
"shared",
@@ -5608,7 +5608,7 @@ in the directory represented by
<para>
If the original Node is a File Node,
-these methods will place the the new Node in the same
+these methods will place the new Node in the same
directory as the one the original Node represents:
</para>
@@ -5685,7 +5685,7 @@ Aliases are virtual objects - they will not themselves result
in physical objects being constructed, but are entered into
the dependency graph related to their sources.
An alias is checked for up to date by checking if
-its sources are up to date.
+its sources are up-to-date.
An alias is built by making sure its sources have been built,
and if any building took place,
applying any Actions that are defined as part of the alias.
@@ -5697,7 +5697,7 @@ which is used for disambiguation.
If an alias source has a string valued name,
it will be resolved to a filesystem entry Node,
unless it is found in the alias namespace,
-in which case it it resolved to the matching alias Node.
+in which case it is resolved to the matching alias Node.
As a result, the order of &f-Alias; calls is significant.
An alias can refer to another alias, but only if the
other alias has previously been created.
@@ -5707,7 +5707,7 @@ other alias has previously been created.
The &f-link-Value; method returns a Value Node.
Value nodes are often used for generated data that
will not have any corresponding filesystem entry,
-but will be used to determine whether a build target is out of date,
+but will be used to determine whether a build target is out-of-date,
or to include as part of a build Action.
Common examples are timestamp strings,
revision control version strings
@@ -5864,7 +5864,7 @@ If the suffix is a string, then
&scons;
prepends a <literal>'.'</literal> to the suffix if it's not already there.
The string returned by the callable object or obtained from the
-dictionary is untouched and you need to manually prepend a <literal>'.'</literal>
+dictionary is untouched, and you need to manually prepend a <literal>'.'</literal>
if one is required.</para>
<programlisting language="python">
@@ -7637,7 +7637,7 @@ expensive for limited benefit -
consider for example the C standard header file
<filename>string.h</filename>.
The scanner function is not passed any special information
-to help make this choice, so the decision making encoded
+to help make this choice, so the decision-making encoded
in the scanner function must be carefully considered.
</para>
@@ -7794,7 +7794,7 @@ Nodes for additional scanning.</para>
</variablelist>
<para>
-Once created, a Scanner can added to an environment
+Once created, a Scanner can be added to an environment
by setting it in the &cv-link-SCANNERS; list,
which automatically triggers &SCons; to also add it
to the environment as a method.
@@ -7968,7 +7968,7 @@ env = Environment(tools=[my_tool])
<para>An element of the <parameter>tools</parameter> list
may also be a two-element list or tuple of the form
<literal>(toolname, kw_dict)</literal>.
-SCons searches for the a tool specification module
+SCons searches for the tool specification module
<parameter>toolname</parameter>
as described above,
and passes <parameter>kw_dict</parameter>,
@@ -8067,7 +8067,7 @@ dialect setup (expressed as a set of &consvars;)
depending on the file suffix.
By default, all of these setups start out the same,
but individual &consvars; can be modified as needed to tune a given dialect.
-Each of these dialacts has a tool specification module
+Each of these dialects has a tool specification module
whose documentation describes the &consvars; associated
with that dialect: <filename>.f</filename>
(as well as <filename>.for</filename> and <filename>.ftn</filename>)
@@ -8096,7 +8096,7 @@ code that was the only available option in FORTRAN 77 and earlier,
and <filename>.f90</filename> refers to free-format source code
which became available as of the Fortran 90 standard.
Some compilers recognize suffixes which correspond to Fortran
-specifications later then F90 as equivalent to
+specifications later than F90 as equivalent to
<filename>.f90</filename> for this purpose,
while some do not - check the documentation for your compiler.
An occasionally suggested policy suggestion is to use only
@@ -8146,7 +8146,7 @@ which shall first be run through
the standard C preprocessor.
The lower-cased versions of these suffixes do not
trigger this behavior.
-On systems which do not distinguish between uppper
+On systems which do not distinguish between upper
and lower case in filenames,
this behavior is not available,
but files suffixed with either
@@ -8226,8 +8226,8 @@ in particular the recommendation to use the msys2 version of
<filename>scons.bat</filename> batch file,
there are (at least) two ramifications.
Note this is no longer the default - &scons; installed
-via &Python;''s <command>pip</command> installer
-will have an <command>scons.exe</command> which does
+via &Python;'s <command>pip</command> installer
+will have a <command>scons.exe</command> which does
not have these limitations:
</para>
@@ -8848,7 +8848,7 @@ env.Program('MyApp', ['Foo.cpp', 'Bar.cpp'])
<para>In general, &scons; is not controlled by environment
variables set in the shell used to invoke it, leaving it
up to the &SConscript; file author to import those if desired.
-However the following variables are imported by
+However, the following variables are imported by
&scons; itself if set:
</para>
diff --git a/doc/python10/summary.xml b/doc/python10/summary.xml
index a8f8767..0b61198 100644
--- a/doc/python10/summary.xml
+++ b/doc/python10/summary.xml
@@ -40,7 +40,7 @@
This paper has introduced &SCons;, a next-generation build tool
with a modular, embeddable architecture and a direct Python
interface. &SCons; has a global view of the dependencies in a source
- tree, uses MD5 signatures to decide if derived files are out of date,
+ tree, uses MD5 signatures to decide if derived files are out-of-date,
and automatically scans files for dependencies, all of which make &SCons;
builds exceptionally reliable. The &SCons; development methodology has
been described, notable for its emphasis on automated regression
diff --git a/doc/user/add-method.xml b/doc/user/add-method.xml
index 071d654..001a575 100644
--- a/doc/user/add-method.xml
+++ b/doc/user/add-method.xml
@@ -54,14 +54,14 @@ This file is processed by the bin/SConsDoc.py module.
<scons_example name="addmethod_ex1">
<file name="SConstruct" printme="1">
def install_in_bin_dirs(env, source):
- """Install source in both bin dirs"""
+ """Install source in both bin directories"""
i1 = env.Install("$BIN", source)
i2 = env.Install("$LOCALBIN", source)
return [i1[0], i2[0]] # Return a list, like a normal builder
env = Environment(BIN='__ROOT__/usr/bin', LOCALBIN='#install/bin')
env.AddMethod(install_in_bin_dirs, "InstallInBinDirs")
-env.InstallInBinDirs(Program('hello.c')) # installs hello in both bin dirs
+env.InstallInBinDirs(Program('hello.c')) # installs hello in both bin directories
</file>
<file name="hello.c">
int main() { printf("Hello, world!\n"); }
diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml
index d34512e..9278fa5 100644
--- a/doc/user/build-install.xml
+++ b/doc/user/build-install.xml
@@ -121,7 +121,7 @@ Python 3.9.15
stating something like <computeroutput>"command not found"</computeroutput>
(on UNIX or Linux)
or <computeroutput>"'python' is not recognized as an internal
- or external command, operable progam or batch file"</computeroutput>
+ or external command, operable program or batch file"</computeroutput>
(on Windows <command>cmd</command>).
In that case, you need to either install &Python;
or fix the search path
@@ -155,7 +155,7 @@ Python 3.9.15
<para>
Recent versions of the Mac no longer come with &Python;
- pre-installed; older versions came with a rather out of date
+ pre-installed; older versions came with a rather out-of-date
version (based on &Python; 2.7) which is insufficient to run
current &SCons;.
The python.org installer can be used on the Mac, but there are
@@ -298,7 +298,7 @@ $ <userinput>python <replaceable>/path/to/unpacked</replaceable>/scripts/scons.p
of &Python; software). There is a <filename>setup.py</filename> file,
but it is only tested and used for the automated procedure which
prepares an &SCons; bundle for making a release on PyPI,
- and even that is not guaranteed to work in future.
+ and even that is not guaranteed to work in the future.
</para>
</section>
diff --git a/doc/user/builders-writing.xml b/doc/user/builders-writing.xml
index b094537..8d2c948 100644
--- a/doc/user/builders-writing.xml
+++ b/doc/user/builders-writing.xml
@@ -42,7 +42,7 @@ This file is processed by the bin/SConsDoc.py module.
for any custom file types you want to build.
(In fact, the &SCons; interfaces for creating
&Builder; objects are flexible enough and easy enough to use
- that all of the the &SCons; built-in &Builder; objects
+ that all of the &SCons; built-in &Builder; objects
are created using the mechanisms described in this section.)
</para>
@@ -132,7 +132,7 @@ env.Foo('file.foo', 'file.input')
<para>
- Then when we run &SCons; it looks like:
+ Then, when we run &SCons; it looks like:
</para>
@@ -819,7 +819,7 @@ cat
to the file specified by the option's argument.
If this option is just supplied to the build,
&SCons; will not consider the link map file a tracked target,
- which has various undesirable efffects.
+ which has various undesirable effects.
</para>
@@ -927,7 +927,7 @@ main()
The <filename>site_scons</filename> directories give you a place to
put &Python; modules and packages that you can import into your
- &SConscript; files (at the top level)
+ &SConscript; files (at the top level),
add-on tools that can integrate into &SCons;
(in a <filename>site_tools</filename> subdirectory),
and a <filename>site_scons/site_init.py</filename> file that
@@ -941,9 +941,9 @@ main()
Each system type (Windows, Mac, Linux, etc.) searches a canonical
set of directories for <filename>site_scons</filename>;
see the man page for details.
- The top-level SConstruct's <filename>site_scons</filename> dir
+ The top-level SConstruct's <filename>site_scons</filename> directory
(that is, the one in the project) is always searched last,
- and its dir is placed first in the tool path so it overrides all
+ and its directory is placed first in the tool path so it overrides all
others.
</para>
@@ -952,7 +952,7 @@ main()
If you get a tool from somewhere (the &SCons; wiki or a third party,
for instance) and you'd like to use it in your project, a
- <filename>site_scons</filename> dir is the simplest place to put it.
+ <filename>site_scons</filename> directory is the simplest place to put it.
Tools come in two flavors; either a &Python; function that operates on
an &Environment; or a &Python; module or package containing two functions,
<function>exists()</function> and <function>generate()</function>.
@@ -1038,7 +1038,7 @@ env.AddHeader('tgt', 'src')
to include in their &SConscript; files: just put them in
<filename>site_scons/my_utils.py</filename>
or any valid &Python; module name of your
- choice. For instance you can do something like this in
+ choice. For instance, you can do something like this in
<filename>site_scons/my_utils.py</filename> to add
<function>build_id</function> and <function>MakeWorkDir</function>
functions:
diff --git a/doc/user/caching.xml b/doc/user/caching.xml
index 85a54f0..36dfc78 100644
--- a/doc/user/caching.xml
+++ b/doc/user/caching.xml
@@ -86,8 +86,8 @@ CacheDir('/usr/local/build_cache')
this directory would typically be
on a shared or NFS-mounted file system.
While &SCons; will create the specified cache directory as needed,
- in this multi user scenario it is usually best
- to create it ahead of time so the access rights
+ in this multiuser scenario it is usually best
+ to create it ahead of time, so the access rights
can be set up correctly.
</para>
@@ -124,7 +124,7 @@ CacheDir('/usr/local/build_cache')
</para>
<para>
- The use of the &buildsig; provides protection from concflicts:
+ The use of the &buildsig; provides protection from conflicts:
if two developers have different setups, so they would produce
built objects that are not identical, then because the difference in
tools will show up in the &buildsig;, which is used as the
@@ -240,7 +240,7 @@ hello.c
<para>
- Then when you run &scons; after cleaning
+ Then, when you run &scons; after cleaning
the built targets,
it will recompile the object file locally
(since it doesn't exist in the derived-file cache directory),
@@ -337,7 +337,7 @@ Retrieved `hello' from cache
<para>
- In this case, you can use the
+ In this case, you can use
the <option>--cache-force</option> option
to tell &SCons; to put all derived files in the cache,
even if the files already exist in your local tree
diff --git a/doc/user/command-line.xml b/doc/user/command-line.xml
index c0a3c0c..5245edf 100644
--- a/doc/user/command-line.xml
+++ b/doc/user/command-line.xml
@@ -795,7 +795,7 @@ foo.in
You may want to control various aspects
of your build by allowing
<varname>variable</varname>=<replaceable>value</replaceable>
- values to be specified on the command line.
+ pairs to be specified on the command line.
For example, suppose you want to be able to
build a debug version of a program
by running &SCons; as follows:
diff --git a/doc/user/depends.xml b/doc/user/depends.xml
index 0950806..d408353 100644
--- a/doc/user/depends.xml
+++ b/doc/user/depends.xml
@@ -437,7 +437,7 @@ cc -o hello hello.o
will have been performed by simply looking at the
modification time of the &hello_c; file,
not by opening it and performing
- a signature calcuation on its contents.
+ a signature calculation on its contents.
This can significantly speed up many up-to-date builds.
</para>
@@ -555,7 +555,7 @@ int main() { printf("Hello, world!\n"); }
<listitem>
<para>
The &contentsig;:
- a cryptgraphic hash, or checksum, of the file contents
+ a cryptographic hash, or checksum, of the file contents
of the <varname>dependency</varname>
file the last time the &target; was built.
</para>
@@ -966,7 +966,7 @@ SetOption('implicit_cache', 1)
When &implicit-cache; is used, &SCons; will ignore any changes that
may have been made to search paths
- (like &cv-CPPPATH; or &cv-LIBPATH;,).
+ (like &cv-CPPPATH; or &cv-LIBPATH;).
This can lead to &SCons; not rebuilding a file if a change to
&cv-CPPPATH; would normally cause a different, same-named file from
a different directory to be used.
@@ -1001,7 +1001,7 @@ SetOption('implicit_cache', 1)
external code that you use for compilation,
the external header files will have changed
and the previously-cached implicit dependencies
- will be out of date.
+ will be out-of-date.
You can update them by
running &SCons; with the &implicit-deps-changed; option:
@@ -1026,7 +1026,7 @@ SetOption('implicit_cache', 1)
<para>
- By default when caching dependencies,
+ By default, when caching dependencies,
&SCons; notices when a file has been modified
and re-scans the file for any updated
implicit dependency information.
diff --git a/doc/user/environments.xml b/doc/user/environments.xml
index a630c65..6807694 100644
--- a/doc/user/environments.xml
+++ b/doc/user/environments.xml
@@ -1609,7 +1609,7 @@ print("NEW_VARIABLE = %s" % env['NEW_VARIABLE'])
<para>
- Some times it's useful to add a new value
+ Sometimes it's useful to add a new value
to the beginning of a &consvar;
only if the existing value
doesn't already contain the to-be-added value.
@@ -1842,7 +1842,7 @@ env['ENV']['PATH'] = ['/usr/local/bin', '/bin', '/usr/bin']
Note that &SCons; does allow you to define
the directories in the &PATH; in a string with paths
- separated by the pathname-separator character
+ separated by the pathname separator character
for your system (<literal>':'</literal> on POSIX systems,
<literal>';'</literal> on Windows).
@@ -2018,7 +2018,7 @@ env.AppendENVPath('LIB', '/usr/local/lib')
</para>
<sconstruct>
-# Builtin tool or tool located within site_tools
+# Built-in tool or tool located within site_tools
env = Environment(tools=['SomeTool'])
env.SomeTool(targets, sources)
@@ -2068,11 +2068,11 @@ SCons/Tool/SomeTool/__init__.py
<para>
Since &SCons; 3.0, a Builder may be located
- within a sub-directory / sub-package of the toolpath.
+ within a subdirectory / sub-package of the toolpath.
This is similar to namespacing within &Python;.
<!-- TODO: that was an advanced topic!!! -->
With nested or namespaced tools we can use the dot notation
- to specify a sub-directory that the tool is located under.
+ to specify a subdirectory that the tool is located under.
</para>
@@ -2149,10 +2149,10 @@ C:\Python35\Lib\site-packages\someinstalledpackage\SomeTool\__init__.py
<para>
In some cases you may want to use a tool
- located within a installed external pip package.
+ located within an installed external pip package.
This is possible by the use of
<varname>sys.path</varname> with the toolpath.
- However in that situation you need to provide a prefix to the toolname
+ However, in that situation you need to provide a prefix to the toolname
to indicate where it is located within <varname>sys.path</varname>.
</para>
diff --git a/doc/user/external.xml b/doc/user/external.xml
index 71eb849..e462ef0 100644
--- a/doc/user/external.xml
+++ b/doc/user/external.xml
@@ -34,7 +34,7 @@ This file is processed by the bin/SConsDoc.py module.
Sometimes a project needs to interact with other projects
in various ways. For example, many open source projects
make use of components from other open source projects,
- and want to use those in their released form, not recode
+ and want to use those in their released form, not rewrite
their builds into &SCons;. As another example, sometimes
the flexibility and power of &SCons; is useful for managing the
overall project, but developers might like faster incremental
@@ -376,7 +376,7 @@ conda install -c conda-forge ninja
<para>
When &ninja; runs the generated &ninja; build file, &ninja; will launch &scons; as a daemon and feed commands
to that &scons; process which &ninja; is unable to build directly. This daemon will stay alive until
- explicitly killed, or it times out. The timeout is set by &cv-link-NINJA_SCONS_DAEMON_KEEP_ALIVE; .
+ explicitly killed, or it times out. The timeout is set by &cv-link-NINJA_SCONS_DAEMON_KEEP_ALIVE;.
</para>
<para>
diff --git a/doc/user/file-removal.xml b/doc/user/file-removal.xml
index 7e5df66..a91d9e0 100644
--- a/doc/user/file-removal.xml
+++ b/doc/user/file-removal.xml
@@ -34,14 +34,14 @@ This file is processed by the bin/SConsDoc.py module.
There are two occasions when &SCons; will,
by default, remove target files.
The first is when &SCons; determines that
- an target file needs to be rebuilt
+ a target file needs to be rebuilt
and removes the existing version of the target
before executing
The second is when &SCons; is invoked with the
<literal>-c</literal> option to "clean"
a tree of its built targets.
- These behaviours can be suppressed with the
+ These behaviors can be suppressed with the
&Precious; and &NoClean; functions, respectively.
</para>
diff --git a/doc/user/gettext.xml b/doc/user/gettext.xml
index cabf883..73cb1ae 100644
--- a/doc/user/gettext.xml
+++ b/doc/user/gettext.xml
@@ -86,16 +86,16 @@ hello = Program(["hello.c"])
</para>
<para>
- Now we'll convert the project to a multi-lingual one. If you don't
+ Now we'll convert the project to a multilingual one. If you don't
already have <ulink
url="http://www.gnu.org/software/gettext/manual/gettext.html">GNU gettext
- utilities</ulink> installed, install them from your preffered
+ utilities</ulink> installed, install them from your preferred
package repository, or download from <ulink
url="http://ftp.gnu.org/gnu/gettext/">
http://ftp.gnu.org/gnu/gettext/</ulink>. For the purpose of this example,
you should have following three locales installed on your system:
<literal>en_US</literal>, <literal>de_DE</literal> and
- <literal>pl_PL</literal>. On debian, for example, you may enable certain
+ <literal>pl_PL</literal>. On Debian, for example, you may enable certain
locales through <command>dpkg-reconfigure locales</command>.
</para>
@@ -163,7 +163,7 @@ InstallAs(["locale/de/LC_MESSAGES/hello.mo"], ["de.mo"])
</para>
<para>
Generate the translation files with <command>scons po-update</command>.
- You should see the output from SCons simillar to this:
+ You should see the output from SCons similar to this:
<screen>
user@host:$ scons po-update
scons: Reading SConscript files ...
@@ -231,7 +231,7 @@ scons: done building targets.
these files under <filename>locale</filename> folder.
</para>
<para>
- Your program should be now ready. You may try it as follows (linux):
+ Your program should be now ready. You may try it as follows (Linux):
<screen>
user@host:$ LANG=en_US.UTF-8 ./hello
Welcome to beautiful world
@@ -350,7 +350,7 @@ gcc -o hello.o -c hello.c
gcc -o hello hello.o
scons: done building targets.
</screen>
- As you see, the internationalized messages ditn't change, so the
+ As you see, the internationalized messages didn't change, so the
<literal>POT</literal> and the rest of translation files have not
even been touched.
</para>
diff --git a/doc/user/hierarchy.xml b/doc/user/hierarchy.xml
index 84b0824..9bce052 100644
--- a/doc/user/hierarchy.xml
+++ b/doc/user/hierarchy.xml
@@ -370,8 +370,8 @@ x
in one pass, interpreting each in its local context,
building up a tree of information, before starting to
execute the needed builds in a second pass.
- This is quite different than some other build tools
- which implement a heirarcical build by recursing.
+ This is quite different from some other build tools
+ which implement a hierarchical build by recursing.
</para>
@@ -893,7 +893,7 @@ void bar(void) { printf("bar/bar.c\n"); }
(The corresponding
<filename>bar/SConscript</filename>
file should be pretty obvious.)
- Then when we run &SCons;,
+ Then, when we run &SCons;,
the object files from the subsidiary subdirectories
are all correctly archived in the desired library:
diff --git a/doc/user/java.xml b/doc/user/java.xml
index a08b406..f53fcf4 100644
--- a/doc/user/java.xml
+++ b/doc/user/java.xml
@@ -597,11 +597,11 @@ public class Example3
<para>
- Note that the the <command>javah</command> command was
+ Note that the <command>javah</command> command was
removed from the JDK as of JDK 10, and the approved method
(available since JDK 8) is to use <command>javac</command>
to generate native headers at the same time as the Java source
- code is compiled.. As such the &b-link-JavaH; builder
+ code is compiled. As such the &b-link-JavaH; builder
is of limited utility in later Java versions.
</para>
diff --git a/doc/user/less-simple.xml b/doc/user/less-simple.xml
index f59a905..19dab6f 100644
--- a/doc/user/less-simple.xml
+++ b/doc/user/less-simple.xml
@@ -301,7 +301,7 @@ Program('hello', ['hello.c'])
Although &SCons; functions
are forgiving about whether or not you
use a string vs. a list for a single file name,
- &Python; itself is more strict about
+ &Python; itself is stricter about
treating lists and strings differently.
So where &SCons; allows either
a string or list:
@@ -376,7 +376,7 @@ Program('program', Split('main.c file1.c file2.c'))
(If you're already familiar with &Python;,
you'll have realized that this is similar to the
<function>split()</function> method
- of &Python; string objects..
+ of &Python; string objects.
Unlike the <function>split()</function> method,
however, the &Split; function
does not require a string as input
diff --git a/doc/user/make.xml b/doc/user/make.xml
index 442dc15..b50cbd6 100644
--- a/doc/user/make.xml
+++ b/doc/user/make.xml
@@ -43,7 +43,7 @@ original make utility and its derivatives have contributed to this tendency
in a number of ways. Make is not good at dealing with systems that are
spread over multiple directories. Various work-arounds are used to overcome
this difficulty; the usual choice is for make to invoke itself recursively
-for each sub-directory of a build. This leads to complicated code, in which
+for each subdirectory of a build. This leads to complicated code, in which
it is often unclear how a variable is set, or what effect the setting of a
variable will have on the build as a whole. The make scripting language has
gradually been extended to provide more possibilities, but these have
@@ -60,7 +60,7 @@ dependencies. Most often, an attempt is made to do a reasonable job of
dependencies within a single directory, but no serious attempt is made to do
the job between directories. Even when dependencies are working correctly,
make's reliance on a simple time stamp comparison to determine whether a
-file is out of date with respect to its dependents is not, in general,
+file is out-of-date with respect to its dependents is not, in general,
adequate for determining when a file should be rederived. If an external
library, for example, is rebuilt and then ``snapped'' into place, the
timestamps on its newly created files may well be earlier than the last
diff --git a/doc/user/misc.xml b/doc/user/misc.xml
index df507df..f78fb35 100644
--- a/doc/user/misc.xml
+++ b/doc/user/misc.xml
@@ -252,7 +252,7 @@ hello.c
Note that the &Exit; function
is equivalent to calling the Python
<function>sys.exit</function> function
- (which the it actually calls),
+ (which it actually calls),
but because &Exit; is a &SCons; function,
you don't have to import the Python
<literal>sys</literal> module to use it.
diff --git a/doc/user/nodes.xml b/doc/user/nodes.xml
index be0f9f6..a652e79 100644
--- a/doc/user/nodes.xml
+++ b/doc/user/nodes.xml
@@ -301,7 +301,7 @@ int main() { printf("Hello, world!\n"); }
is the name of the file.
If you want to do something other than
print the name of the file,
- you can fetch it by using the builtin Python
+ you can fetch it by using the built-in Python
&str; function.
For example, if you want to use the Python
<function>os.path.exists</function>
diff --git a/doc/user/output.xml b/doc/user/output.xml
index 4072e7f..abb6e90 100644
--- a/doc/user/output.xml
+++ b/doc/user/output.xml
@@ -31,7 +31,7 @@ This file is processed by the bin/SConsDoc.py module.
<para>
A key aspect of creating a usable build configuration
- is providing useful output from the build
+ is providing useful output from the build,
so its users can readily understand
what the build is doing
and get information about how to control the build.
diff --git a/doc/user/parseconfig.xml b/doc/user/parseconfig.xml
index ee52c92..a4b4618 100644
--- a/doc/user/parseconfig.xml
+++ b/doc/user/parseconfig.xml
@@ -34,7 +34,7 @@ This file is processed by the bin/SConsDoc.py module.
libraries--especially shared libraries--that are available
on POSIX systems can be complex.
To help this situation,
- various utilies with names that end in <filename>config</filename>
+ various utilities with names that end in <filename>config</filename>
return the command-line options for the GNU Compiler Collection (GCC)
that are needed to build and link against those libraries;
for example, the command-line options
diff --git a/doc/user/parseflags.xml b/doc/user/parseflags.xml
index 90e166a..eef242d 100644
--- a/doc/user/parseflags.xml
+++ b/doc/user/parseflags.xml
@@ -148,7 +148,7 @@ void main() { return 0; }
<para>
- If a string begins with a an exclamation mark (<literal>!</literal>),
+ If a string begins with an exclamation mark (<literal>!</literal>),
the string is passed to the shell for execution.
The output of the command is then parsed:
diff --git a/doc/user/scanners.xml b/doc/user/scanners.xml
index 6785771..5ead526 100644
--- a/doc/user/scanners.xml
+++ b/doc/user/scanners.xml
@@ -462,7 +462,7 @@ kscan = Scanner(
<para>
One approach for introducing a &Scanner; into the build is in
- conjunction with a &Builder;. There are two relvant optional
+ conjunction with a &Builder;. There are two relevant optional
parameters we can use when creating a Builder:
<parameter>source_scanner</parameter> and
<parameter>target_scanner</parameter>.
@@ -523,7 +523,7 @@ text to include
<para>
Running this example would only show that the stub
<function>build_function</function> is getting called,
- so some debug prints were added to the scaner function,
+ so some debug prints were added to the scanner function,
just to show the scanner is being invoked.
</para>
diff --git a/doc/user/sconf.xml b/doc/user/sconf.xml
index e257092..3eb89c1 100644
--- a/doc/user/sconf.xml
+++ b/doc/user/sconf.xml
@@ -288,7 +288,7 @@ env = conf.Finish()
You can also add a string that will be
placed at the beginning of the test file
that will be used to check for the &typedef;.
- This provide a way to specify
+ This provides a way to specify
files that must be included to find the &typedef;:
</para>
diff --git a/doc/user/separate.xml b/doc/user/separate.xml
index 4ba5558..394bf6b 100644
--- a/doc/user/separate.xml
+++ b/doc/user/separate.xml
@@ -79,7 +79,7 @@ This file is processed by the bin/SConsDoc.py module.
The key to making this separation work is the ability to
do out-of-tree builds: building under a separate root
than the sources being built.
- You set up out of tree builds by establishing what &SCons;
+ You set up out-of-tree builds by establishing what &SCons;
calls a <firstterm>variant directory</firstterm>,
a place where you can build a single variant of your software
(of course you can define more than one of these if you need to).
@@ -208,7 +208,7 @@ int main() { printf("Hello, world!\n"); }
except for the extra &variant_dir; argument in the
&f-link-SConscript; call.
&SCons; handles all the path adjustments for the
- out of tree &build; directory while it processes that SConscript file.
+ out-of-tree &build; directory while it processes that SConscript file.
</para>
@@ -219,7 +219,7 @@ int main() { printf("Hello, world!\n"); }
<para>
- When you set up a variant directory &SCons; conceptually behaves as
+ When you set up a variant directory, &SCons; conceptually behaves as
if you requested a build in that directory.
As noted in the previous chapter,
all builds actually happen from the top level directory,
@@ -227,8 +227,8 @@ int main() { printf("Hello, world!\n"); }
of it as <emphasis>build in place in the variant directory</emphasis>,
not <emphasis>build in source but send build artifacts
to the variant directory</emphasis>.
- It turns out in place builds are easier to get right than out
- of tree builds - so by default &SCons; simulates an in place build
+ It turns out in place builds are easier to get right than out-of-tree
+ builds - so by default &SCons; simulates an in place build
by making the variant directory look just like the source directory.
The most straightforward way to do that is by making copies
of the files needed for the build.
@@ -498,7 +498,7 @@ int main() { printf("Hello, world!\n"); }
to the use of &f-link-SConscript; with the
<parameter>variant_dir</parameter> argument
from earlier in this chapter,
- but did require callng the SConscript using the already established
+ but did require calling the SConscript using the already established
variant directory path to trigger that behavior.
If you call <userinput>SConscript('src/SConscript')</userinput>
you would get a normal in-place build in &src;.
diff --git a/doc/user/sideeffect.xml b/doc/user/sideeffect.xml
index 07d619f..c1e2433 100644
--- a/doc/user/sideeffect.xml
+++ b/doc/user/sideeffect.xml
@@ -47,7 +47,7 @@ This file is processed by the bin/SConsDoc.py module.
will also put data into <filename>log</filename>, which is used
as a source for the command to generate <filename>file2</filename>,
but <filename>log</filename> is unknown to &SCons; on a clean
- build: it neither exists, nor is it a target output by any builder.
+ build: it neither exists nor is it a target output by any builder.
The <filename>SConscript</filename> uses
&SideEffect; to inform &SCons; about the additional output file.
@@ -114,14 +114,14 @@ f1 = env.Command(
In general, &SideEffect; is not intended for the case when
a command produces extra target files (that is, files which
- will be used as sources to other build steps). For example, the
+ will be used as sources to other build steps). For example,
the &MSVC; compiler is capable of performing
incremental linking, for which it uses a status file - such that
linking <filename>foo.exe</filename> also produces
a <filename>foo.ilk</filename>, or uses it if it was already present,
if the <option>/INCREMENTAL</option> option was supplied.
Specifying <filename>foo.ilk</filename> as a
- side-effect of <filename>foo.exe</filename>
+ side effect of <filename>foo.exe</filename>
is <emphasis>not</emphasis> a recommended use of &SideEffect;
since <filename>foo.ilk</filename> is used by the link.
&SCons; handles side-effect files
@@ -245,7 +245,7 @@ cat
<para>
- This makes sure the the two
+ This makes sure the two
<application>./build</application> steps are run sequentially,
even with the <filename>--jobs=2</filename> in the command line:
diff --git a/doc/user/simple.xml b/doc/user/simple.xml
index 7a06513..9f57d33 100644
--- a/doc/user/simple.xml
+++ b/doc/user/simple.xml
@@ -487,7 +487,7 @@ int main() { printf("Goodbye, world!\n"); }
<para>
- Then when you execute &SCons;,
+ Then, when you execute &SCons;,
you will see the output from calling the <function>print</function>
function in between the messages about
reading the &SConscript; files,
diff --git a/doc/user/troubleshoot.xml b/doc/user/troubleshoot.xml
index 72c6fd6..e2b59a5 100644
--- a/doc/user/troubleshoot.xml
+++ b/doc/user/troubleshoot.xml
@@ -193,7 +193,7 @@ file3.c
This becomes even more helpful
in identifying when a file is rebuilt
due to a change in an implicit dependency,
- such as an incuded <filename>.h</filename> file.
+ such as an included <filename>.h</filename> file.
If the <filename>file1.c</filename>
and <filename>file3.c</filename> files
in our example
@@ -321,7 +321,7 @@ print(env.Dump())
interested in,
the &Dump; method allows you to
specify a specific &consvar;
- that you want to disply.
+ that you want to display.
For example,
it's not unusual to want to verify
the external environment used to execute build commands,
@@ -426,7 +426,7 @@ inc.h
<para>
- By default &SCons; uses "ASCII art" to draw the tree. It is
+ By default, &SCons; uses "ASCII art" to draw the tree. It is
possible to use line-drawing characters (Unicode calls these
Box Drawing) to make a nicer display. To do this, add the
<option>linedraw</option> qualifier:
@@ -658,7 +658,7 @@ cc -o prog prog.o
To get some insight into what library names
&SCons; is searching for,
and in which directories it is searching,
- Use the &debug-findlibs; option.
+ use the &debug-findlibs; option.
Given the following input &SConstruct; file:
</para>
@@ -877,7 +877,7 @@ prog.c
<para>
- Sometimes SCons doesn't build the target you want
+ Sometimes SCons doesn't build the target you want,
and it's difficult to figure out why. You can use
the &debug-prepare; option
to see all the targets &SCons; is considering, and whether
@@ -893,7 +893,7 @@ prog.c
<para>
- When using the &Duplicate; option to create variant dirs,
+ When using the &Duplicate; option to create variant directories,
sometimes you may find files not getting linked or copied to where you
expect (or not at all), or files mysteriously disappearing.
These are usually because of a misconfiguration of some kind in the
@@ -901,7 +901,7 @@ prog.c
&debug-duplicate; option shows each time a variant file is
unlinked and relinked from its source (or copied, depending on
settings), and also shows a message for removing "stale"
- variant-dir files that no longer have a corresponding source file.
+ variant-directory files that no longer have a corresponding source file.
It also prints a line for each target that's removed just before
building, since that can also be mistaken for the same thing.
diff --git a/doc/user/variants.xml b/doc/user/variants.xml
index 84a93bf..e2c7ba3 100644
--- a/doc/user/variants.xml
+++ b/doc/user/variants.xml
@@ -128,7 +128,7 @@ int world() { printf "world.c\n"; }
In order to build several variants at once when using the
<parameter>variant_dir</parameter> argument to &SConscript;,
- you can call the function repeatedely - this example
+ you can call the function repeatedly - this example
does so in a loop. Note that the &f-link-SConscript; trick of
passing a list of script files, or a list of source directories,
does not work with <parameter>variant_dir</parameter>,