summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Thiessen <alex.thiessen.de+github@gmail.com>2024-11-15 12:39:26 (GMT)
committerAlex Thiessen <alex.thiessen.de+github@gmail.com>2024-11-15 15:07:51 (GMT)
commitb4ab76fb8f37bb0d9c76c10c91c9365af0861f5d (patch)
tree5d99eba14509bcb9593fc62ffa7a24e1d3501671
parent8aa16624a5dd789043fe0e1e99825d6711ad52b9 (diff)
downloadSCons-b4ab76fb8f37bb0d9c76c10c91c9365af0861f5d.zip
SCons-b4ab76fb8f37bb0d9c76c10c91c9365af0861f5d.tar.gz
SCons-b4ab76fb8f37bb0d9c76c10c91c9365af0861f5d.tar.bz2
*.xml: Add missing commas
-rw-r--r--SCons/Action.xml2
-rw-r--r--SCons/Defaults.xml6
-rw-r--r--SCons/Environment.xml2
-rw-r--r--SCons/Script/Main.xml2
-rw-r--r--SCons/Tool/f03.xml2
-rw-r--r--SCons/Tool/f08.xml2
-rw-r--r--SCons/Tool/f77.xml2
-rw-r--r--SCons/Tool/f90.xml2
-rw-r--r--SCons/Tool/f95.xml2
-rw-r--r--SCons/Tool/fortran.xml2
-rw-r--r--SCons/Tool/jar.xml2
-rw-r--r--SCons/Tool/javac.xml2
-rw-r--r--SCons/Tool/link.xml4
-rw-r--r--SCons/Tool/msvc.xml2
-rw-r--r--SCons/Tool/msvs.xml4
-rw-r--r--SCons/Tool/textfile.xml4
-rw-r--r--SCons/Tool/zip.xml2
-rw-r--r--doc/man/scons-time.xml2
-rw-r--r--doc/man/scons.xml12
-rw-r--r--doc/user/builders-writing.xml4
-rw-r--r--doc/user/caching.xml4
-rw-r--r--doc/user/depends.xml2
-rw-r--r--doc/user/environments.xml2
-rw-r--r--doc/user/hierarchy.xml2
-rw-r--r--doc/user/output.xml2
-rw-r--r--doc/user/separate.xml2
-rw-r--r--doc/user/simple.xml2
-rw-r--r--doc/user/troubleshoot.xml4
28 files changed, 41 insertions, 41 deletions
diff --git a/SCons/Action.xml b/SCons/Action.xml
index 738df78..906324c 100644
--- a/SCons/Action.xml
+++ b/SCons/Action.xml
@@ -61,7 +61,7 @@ Action strings can be segmented by the
use of an AND operator, <literal>&amp;&amp;</literal>.
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 80ec4cd..f621528 100644
--- a/SCons/Defaults.xml
+++ b/SCons/Defaults.xml
@@ -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 look-up a directory relative to the root of the source tree, use
the <literal>#</literal> prefix:
</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 look-up a directory relative to the root of the source tree, use
the <literal>#</literal> prefix:
</para>
diff --git a/SCons/Environment.xml b/SCons/Environment.xml
index 87d1e7c..be32fa5 100644
--- a/SCons/Environment.xml
+++ b/SCons/Environment.xml
@@ -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>
diff --git a/SCons/Script/Main.xml b/SCons/Script/Main.xml
index 01a3b90..38d8dad 100644
--- a/SCons/Script/Main.xml
+++ b/SCons/Script/Main.xml
@@ -200,7 +200,7 @@ 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
+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>
diff --git a/SCons/Tool/f03.xml b/SCons/Tool/f03.xml
index e5df9eb..e18439c 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 look-up 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,
diff --git a/SCons/Tool/f08.xml b/SCons/Tool/f08.xml
index e50f857..dcf1b49 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 look-up 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,
diff --git a/SCons/Tool/f77.xml b/SCons/Tool/f77.xml
index a98c110..5420c62 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 look-up 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,
diff --git a/SCons/Tool/f90.xml b/SCons/Tool/f90.xml
index 0a2f6a0..4310ed8 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 look-up 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,
diff --git a/SCons/Tool/f95.xml b/SCons/Tool/f95.xml
index 3e96484..91e5a48 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 look-up 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,
diff --git a/SCons/Tool/fortran.xml b/SCons/Tool/fortran.xml
index 944eb3e..799e1d6 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 look-up a directory relative to the root of the source tree, use #:
</para>
<example_commands>
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 ccda885..b6b3f6e 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 portability, 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 0b10768..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. Otherwise 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. Otherwise it evaluates to an empty string.
<summary>
<para>
This construction variable automatically introduces &cv-link-_SHLIBVERSIONFLAGS;
-if &cv-link-SHLIBVERSION; is set. Otherwise 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 acf9c5b..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 defined 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:
diff --git a/SCons/Tool/msvs.xml b/SCons/Tool/msvs.xml
index dba3257..bf9cd52 100644
--- a/SCons/Tool/msvs.xml
+++ b/SCons/Tool/msvs.xml
@@ -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>
@@ -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
diff --git a/SCons/Tool/textfile.xml b/SCons/Tool/textfile.xml
index 2539f5a..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>
@@ -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>
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/man/scons-time.xml b/doc/man/scons-time.xml
index 394beba..c5bc139 100644
--- a/doc/man/scons-time.xml
+++ b/doc/man/scons-time.xml
@@ -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 c915c17..b8172ae 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.
@@ -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)
@@ -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.
@@ -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,
@@ -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">
@@ -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/user/builders-writing.xml b/doc/user/builders-writing.xml
index d0938fa..b9eb064 100644
--- a/doc/user/builders-writing.xml
+++ b/doc/user/builders-writing.xml
@@ -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>
@@ -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 523781f..885e6c3 100644
--- a/doc/user/caching.xml
+++ b/doc/user/caching.xml
@@ -87,7 +87,7 @@ CacheDir('/usr/local/build_cache')
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
+ to create it ahead of time, so the access rights
can be set up correctly.
</para>
@@ -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),
diff --git a/doc/user/depends.xml b/doc/user/depends.xml
index 0c61e67..23ae612 100644
--- a/doc/user/depends.xml
+++ b/doc/user/depends.xml
@@ -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 80133e8..9c490bd 100644
--- a/doc/user/environments.xml
+++ b/doc/user/environments.xml
@@ -2152,7 +2152,7 @@ C:\Python35\Lib\site-packages\someinstalledpackage\SomeTool\__init__.py
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/hierarchy.xml b/doc/user/hierarchy.xml
index c5cb9b8..8c6b4ca 100644
--- a/doc/user/hierarchy.xml
+++ b/doc/user/hierarchy.xml
@@ -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/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/separate.xml b/doc/user/separate.xml
index 4af3a55..9fc9ba0 100644
--- a/doc/user/separate.xml
+++ b/doc/user/separate.xml
@@ -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,
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 710361c..763e55c 100644
--- a/doc/user/troubleshoot.xml
+++ b/doc/user/troubleshoot.xml
@@ -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:
@@ -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