diff options
author | Alex Thiessen <alex.thiessen.de+github@gmail.com> | 2024-11-15 12:54:27 (GMT) |
---|---|---|
committer | Alex Thiessen <alex.thiessen.de+github@gmail.com> | 2024-11-15 15:07:51 (GMT) |
commit | 9934570fda75537dc392b7b4fc2367606be2759b (patch) | |
tree | 259723b53fd1c01f4caf5e8e85b1c8dd3d14d6ce | |
parent | a277b0c959ab178ca660924ddce96e6b2a9dbf93 (diff) | |
download | SCons-9934570fda75537dc392b7b4fc2367606be2759b.zip SCons-9934570fda75537dc392b7b4fc2367606be2759b.tar.gz SCons-9934570fda75537dc392b7b4fc2367606be2759b.tar.bz2 |
*.xml: Fix hyphens
One of the implemented rules is:
> A compound adjective usually gets a hyphen when it comes before a
> noun.
-rw-r--r-- | SCons/Defaults.xml | 4 | ||||
-rw-r--r-- | SCons/Environment.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/Tool.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/f03.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/fortran.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/msvs.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/swig.xml | 2 | ||||
-rw-r--r-- | doc/man/scons.xml | 6 | ||||
-rw-r--r-- | doc/user/caching.xml | 2 | ||||
-rw-r--r-- | doc/user/environments.xml | 8 | ||||
-rw-r--r-- | doc/user/gettext.xml | 2 | ||||
-rw-r--r-- | doc/user/make.xml | 2 | ||||
-rw-r--r-- | doc/user/nodes.xml | 2 | ||||
-rw-r--r-- | doc/user/separate.xml | 12 | ||||
-rw-r--r-- | doc/user/sideeffect.xml | 2 |
15 files changed, 26 insertions, 26 deletions
diff --git a/SCons/Defaults.xml b/SCons/Defaults.xml index f621528..ce24b3b 100644 --- a/SCons/Defaults.xml +++ b/SCons/Defaults.xml @@ -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> @@ -654,7 +654,7 @@ as dependencies of the target being generated. </para> <para> -The library list will be 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 diff --git a/SCons/Environment.xml b/SCons/Environment.xml index be32fa5..9054c2e 100644 --- a/SCons/Environment.xml +++ b/SCons/Environment.xml @@ -580,7 +580,7 @@ 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 be postprocessed by adding a prefix and/or suffix +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, diff --git a/SCons/Tool/Tool.xml b/SCons/Tool/Tool.xml index ba8b9af..fcd33fe 100644 --- a/SCons/Tool/Tool.xml +++ b/SCons/Tool/Tool.xml @@ -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/f03.xml b/SCons/Tool/f03.xml index e18439c..eaa115d 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/fortran.xml b/SCons/Tool/fortran.xml index 799e1d6..d9a84a5 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/msvs.xml b/SCons/Tool/msvs.xml index bf9cd52..8ccd8d7 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 diff --git a/SCons/Tool/swig.xml b/SCons/Tool/swig.xml index 2d35504..ea5fabf 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 look up a directory relative to the root of the source tree, use a top-relative path (<literal>#</literal>): </para> diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 19063a3..3477d2e 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -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> @@ -5421,7 +5421,7 @@ vars.AddVariables( default="no", allowed_values=("yes", "no", "full"), map={}, - ignorecase=0, # case sensitive + ignorecase=0, # case-sensitive ), ListVariable( "shared", @@ -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> diff --git a/doc/user/caching.xml b/doc/user/caching.xml index 885e6c3..413c72d 100644 --- a/doc/user/caching.xml +++ b/doc/user/caching.xml @@ -86,7 +86,7 @@ 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 + in this multi-user scenario it is usually best to create it ahead of time, so the access rights can be set up correctly. diff --git a/doc/user/environments.xml b/doc/user/environments.xml index 9c490bd..6807694 100644 --- a/doc/user/environments.xml +++ b/doc/user/environments.xml @@ -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> diff --git a/doc/user/gettext.xml b/doc/user/gettext.xml index 5155345..5abebf9 100644 --- a/doc/user/gettext.xml +++ b/doc/user/gettext.xml @@ -86,7 +86,7 @@ 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 preferred diff --git a/doc/user/make.xml b/doc/user/make.xml index 442dc15..a14153f 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 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/separate.xml b/doc/user/separate.xml index 9fc9ba0..effc5aa 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> @@ -224,11 +224,11 @@ int main() { printf("Hello, world!\n"); } As noted in the previous chapter, all builds actually happen from the top level directory, but as an aid to understanding how &SCons; operates, think - of it as <emphasis>build in place in the variant directory</emphasis>, - not <emphasis>build in source but send build artifacts + 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. diff --git a/doc/user/sideeffect.xml b/doc/user/sideeffect.xml index b17f391..cff8985 100644 --- a/doc/user/sideeffect.xml +++ b/doc/user/sideeffect.xml @@ -121,7 +121,7 @@ f1 = env.Command( 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 |