diff options
author | Alex Thiessen <alex.thiessen.de+github@gmail.com> | 2024-11-15 12:02:59 (GMT) |
---|---|---|
committer | Alex Thiessen <alex.thiessen.de+github@gmail.com> | 2024-11-15 14:55:41 (GMT) |
commit | 8aa16624a5dd789043fe0e1e99825d6711ad52b9 (patch) | |
tree | d150431a438742f25de4586a045ea2fb736ce3a6 | |
parent | c1ddbc7fa5e34ae6aba45104e6dfb39ebb08d3eb (diff) | |
download | SCons-8aa16624a5dd789043fe0e1e99825d6711ad52b9.zip SCons-8aa16624a5dd789043fe0e1e99825d6711ad52b9.tar.gz SCons-8aa16624a5dd789043fe0e1e99825d6711ad52b9.tar.bz2 |
*.xml: Fix obvious typos etc.
41 files changed, 120 insertions, 120 deletions
diff --git a/SCons/Action.xml b/SCons/Action.xml index c71c305..738df78 100644 --- a/SCons/Action.xml +++ b/SCons/Action.xml @@ -59,7 +59,7 @@ greater than one, as that has a different meaning). <para> Action strings can be segmented by the use of an AND operator, <literal>&&</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 sequence has been executed. If an diff --git a/SCons/Defaults.xml b/SCons/Defaults.xml index 933fe9d..80ec4cd 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> @@ -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..87d1e7c 100644 --- a/SCons/Environment.xml +++ b/SCons/Environment.xml @@ -572,14 +572,14 @@ 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 +however, the contents of &cv-link-CPPDEFINES; will be postprocessed by adding a prefix and/or suffix to each entry when the command line is produced, so &SCons; keeps them separate - @@ -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 @@ -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> @@ -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> @@ -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..01a3b90 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> @@ -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..ba8b9af 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> 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/javac.xml b/SCons/Tool/javac.xml index d3be4f8..ccda885 100644 --- a/SCons/Tool/javac.xml +++ b/SCons/Tool/javac.xml @@ -109,7 +109,7 @@ 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 + For portability, it's best if the encoding is hard-coded so that the compile will work if it is done on a system with a different encoding. </para> diff --git a/SCons/Tool/link.xml b/SCons/Tool/link.xml index 4bf7969..0b10768 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..acf9c5b 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..dba3257 100644 --- a/SCons/Tool/msvs.xml +++ b/SCons/Tool/msvs.xml @@ -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..65945d3 100644 --- a/SCons/Tool/ninja/ninja.xml +++ b/SCons/Tool/ninja/ninja.xml @@ -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..0c42462 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> @@ -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/textfile.xml b/SCons/Tool/textfile.xml index 895fbef..2539f5a 100644 --- a/SCons/Tool/textfile.xml +++ b/SCons/Tool/textfile.xml @@ -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')], @@ -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..f186a17 100644 --- a/SCons/Tool/tlib.xml +++ b/SCons/Tool/tlib.xml @@ -27,7 +27,7 @@ This file is processed by the bin/SConsDoc.py module. <tool name="tlib"> <summary> <para> -Sets construction variables for the Borlan +Sets construction variables for the Borland <application>tib</application> library archiver. </para> </summary> diff --git a/SCons/Tool/xgettext.xml b/SCons/Tool/xgettext.xml index 10bec3a..fb9c6a3 100644 --- a/SCons/Tool/xgettext.xml +++ b/SCons/Tool/xgettext.xml @@ -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<dir></literal> flags +Internal "macro". Generates list of <literal>-D<dir></literal> flags from the &cv-link-XGETTEXTPATH; list. </para> </summary> diff --git a/doc/man/scons-time.xml b/doc/man/scons-time.xml index 794e593..394beba 100644 --- a/doc/man/scons-time.xml +++ b/doc/man/scons-time.xml @@ -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 diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 022f44c..c915c17 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -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> @@ -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> @@ -1629,7 +1629,7 @@ scons>>> 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> @@ -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> @@ -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 it may be 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>. @@ -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 @@ -3641,7 +3641,7 @@ If there are no targets specified on the command line, the 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 is 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"> @@ -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. @@ -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> @@ -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. @@ -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> diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml index d34512e..f0b400f 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 diff --git a/doc/user/builders-writing.xml b/doc/user/builders-writing.xml index b094537..d0938fa 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> @@ -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 diff --git a/doc/user/caching.xml b/doc/user/caching.xml index 85a54f0..523781f 100644 --- a/doc/user/caching.xml +++ b/doc/user/caching.xml @@ -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 @@ -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/depends.xml b/doc/user/depends.xml index 0950806..0c61e67 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 ⌖ 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. diff --git a/doc/user/environments.xml b/doc/user/environments.xml index a630c65..80133e8 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. @@ -2149,7 +2149,7 @@ 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 diff --git a/doc/user/external.xml b/doc/user/external.xml index 71eb849..4e021f6 100644 --- a/doc/user/external.xml +++ b/doc/user/external.xml @@ -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..082d17e 100644 --- a/doc/user/file-removal.xml +++ b/doc/user/file-removal.xml @@ -34,7 +34,7 @@ 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 diff --git a/doc/user/gettext.xml b/doc/user/gettext.xml index cabf883..5155345 100644 --- a/doc/user/gettext.xml +++ b/doc/user/gettext.xml @@ -89,7 +89,7 @@ hello = Program(["hello.c"]) Now we'll convert the project to a multi-lingual 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, @@ -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 ... @@ -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..c5cb9b8 100644 --- a/doc/user/hierarchy.xml +++ b/doc/user/hierarchy.xml @@ -371,7 +371,7 @@ x 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. + which implement a hierarchical build by recursing. </para> 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..4c1b14d 100644 --- a/doc/user/less-simple.xml +++ b/doc/user/less-simple.xml @@ -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/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/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..4af3a55 100644 --- a/doc/user/separate.xml +++ b/doc/user/separate.xml @@ -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..b17f391 100644 --- a/doc/user/sideeffect.xml +++ b/doc/user/sideeffect.xml @@ -114,7 +114,7 @@ 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 @@ -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/troubleshoot.xml b/doc/user/troubleshoot.xml index 72c6fd6..710361c 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, @@ -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> 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>, |