Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix English issues in the documentation #4649

Merged
merged 24 commits into from
Nov 16, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
8aa1662
*.xml: Fix obvious typos etc.
rico-chet Nov 15, 2024
b4ab76f
*.xml: Add missing commas
rico-chet Nov 15, 2024
a277b0c
*.xml: Use en_US
rico-chet Nov 15, 2024
9934570
*.xml: Fix hyphens
rico-chet Nov 15, 2024
ff44c3b
*.xml: Hyphenate `out of date`
rico-chet Nov 15, 2024
8a43edd
*.xml: Capitalize proper nouns
rico-chet Nov 15, 2024
39f1cb1
*.xml: Remove trailing whitespace
rico-chet Nov 15, 2024
e7848aa
*.xml: Don't abbreviate `directory` in normal text
rico-chet Nov 15, 2024
2cba4ce
*.xml: Fix joined words
rico-chet Nov 15, 2024
73f1cd0
*.xml: Add miscellaneous language improvements
rico-chet Nov 15, 2024
c2a8c0c
[ci skip] Add CHANGES/RELEASE Blurb. Minor edit in ninja.xml
bdbaddog Nov 16, 2024
eb2c287
change look-up -> look up
bdbaddog Nov 16, 2024
cd73fab
change to lookup
bdbaddog Nov 16, 2024
6c64fb9
change look-up and look up -> lookup
bdbaddog Nov 16, 2024
0921270
change look-up and look up -> lookup
bdbaddog Nov 16, 2024
d4bc7a0
[ci skip] change look-up and look up -> lookup
bdbaddog Nov 16, 2024
06ae4b4
[ci skip] change look-up and look up -> lookup, also use the Tool ent…
bdbaddog Nov 16, 2024
a9bcd84
[ci skip] change look-up and look up -> lookup.
bdbaddog Nov 16, 2024
3a6dd27
[ci skip] minor edits
bdbaddog Nov 16, 2024
09b4cea
[ci skip] multi-user should be multiuser
bdbaddog Nov 16, 2024
60a9609
[ci skip] change look-up and look up -> lookup.
bdbaddog Nov 16, 2024
28d3e3b
[ci skip] minor edits
bdbaddog Nov 16, 2024
3307711
[ci skip] minor edits
bdbaddog Nov 16, 2024
e73b7d3
[ci skip] update generated files
bdbaddog Nov 16, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions SCons/Action.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
16 changes: 8 additions & 8 deletions SCons/Defaults.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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.
Expand All @@ -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 look up a directory relative to the root of the source tree, use
the <literal>#</literal> prefix:
</para>

Expand Down Expand Up @@ -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 look-up a directory relative to the root of the source tree, use
the <literal>#</literal> prefix:
</para>

Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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>
Expand Down
52 changes: 26 additions & 26 deletions SCons/Environment.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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>

Expand All @@ -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
Expand Down Expand Up @@ -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;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A similar change is also in #4648

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to merge #4648 first, I'm OK to resolve the conflicts.

Builder methods.
Examples:
</para>
Expand Down Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A similar change is also in #4648

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to merge #4648 first, I'm OK to resolve the conflicts.

</para>
<example_commands>
Clean(docdir, os.path.join(docdir, projectname))
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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? -->
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions SCons/Script/Main.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion SCons/Script/SConscript.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion SCons/Subst.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion SCons/Tool/DCommon.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions SCons/Tool/Tool.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
Loading
Loading