diff options
author | Alex Thiessen <alex.thiessen.de+github@gmail.com> | 2024-11-15 13:17:02 (GMT) |
---|---|---|
committer | Alex Thiessen <alex.thiessen.de+github@gmail.com> | 2024-11-15 15:07:52 (GMT) |
commit | 73f1cd097a3e87c1aff5fdf30d744efdc7d54db2 (patch) | |
tree | 4c30c83cf66f0fd397dd02ea8719d3f2297a51c4 | |
parent | 2cba4ceb8948f32f20de5b6ccf76cca63d280aa4 (diff) | |
download | SCons-73f1cd097a3e87c1aff5fdf30d744efdc7d54db2.zip SCons-73f1cd097a3e87c1aff5fdf30d744efdc7d54db2.tar.gz SCons-73f1cd097a3e87c1aff5fdf30d744efdc7d54db2.tar.bz2 |
*.xml: Add miscellaneous language improvements
-rw-r--r-- | SCons/Environment.xml | 4 | ||||
-rw-r--r-- | SCons/Script/Main.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/gs.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/install.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/javac.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/ninja/ninja.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/packaging/packaging.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/qt3.xml | 2 | ||||
-rw-r--r-- | SCons/Tool/tlib.xml | 2 | ||||
-rw-r--r-- | doc/man/scons.xml | 6 | ||||
-rw-r--r-- | doc/user/build-install.xml | 2 | ||||
-rw-r--r-- | doc/user/command-line.xml | 2 | ||||
-rw-r--r-- | doc/user/external.xml | 2 | ||||
-rw-r--r-- | doc/user/hierarchy.xml | 2 | ||||
-rw-r--r-- | doc/user/less-simple.xml | 2 | ||||
-rw-r--r-- | doc/user/sideeffect.xml | 2 |
16 files changed, 19 insertions, 19 deletions
diff --git a/SCons/Environment.xml b/SCons/Environment.xml index 9248721..dafc649 100644 --- a/SCons/Environment.xml +++ b/SCons/Environment.xml @@ -1033,7 +1033,7 @@ either as separate arguments to the &f-Clean; method, or as a list. &f-Clean; -will also accept the return value of any of the &consenv; +will also accept the return value of the &consenv; Builder methods. Examples: </para> @@ -1065,7 +1065,7 @@ Clean(['foo', 'bar'], 'something_else_to_clean') In this example, installing the project creates a subdirectory for the documentation. This statement causes the subdirectory to be removed -if the project is deinstalled. +if the project is uninstalled. </para> <example_commands> Clean(docdir, os.path.join(docdir, projectname)) diff --git a/SCons/Script/Main.xml b/SCons/Script/Main.xml index 38d8dad..810e8aa 100644 --- a/SCons/Script/Main.xml +++ b/SCons/Script/Main.xml @@ -201,7 +201,7 @@ Future versions of &SCons; will likely forbid such usage. <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 + <emphasis>json</emphasis> which sets the path to the JSON file created when <literal>--debug=json</literal> is set. </para> <example_commands> diff --git a/SCons/Tool/gs.xml b/SCons/Tool/gs.xml index b984fd3..2e0f46e 100644 --- a/SCons/Tool/gs.xml +++ b/SCons/Tool/gs.xml @@ -27,7 +27,7 @@ This file is processed by the bin/SConsDoc.py module. <tool name="gs"> <summary> <para> -This Tool sets the required construction variables for working with +This tool sets the required construction variables for working with the Ghostscript software. It also registers an appropriate Action with the &b-link-PDF; Builder, such that the conversion from PS/EPS to PDF happens automatically for the TeX/LaTeX toolchain. diff --git a/SCons/Tool/install.xml b/SCons/Tool/install.xml index 3069cad..cdb044b 100644 --- a/SCons/Tool/install.xml +++ b/SCons/Tool/install.xml @@ -72,7 +72,7 @@ in this case. If the <option>--install-sandbox</option> command line option is given, the target directory will be prefixed by the directory path specified. -This is useful to test installs without installing to +This is useful to test installation behavior without installing to a "live" location in the system. </para> diff --git a/SCons/Tool/javac.xml b/SCons/Tool/javac.xml index af1fc31..c43470c 100644 --- a/SCons/Tool/javac.xml +++ b/SCons/Tool/javac.xml @@ -110,7 +110,7 @@ env.Java(target='classes', source=['File1.java', 'File2.java']) <literal>LANG</literal> environment variable to tell the compiler what encoding is used. For portability, it's best if the encoding is hard-coded, - so that the compile will work if it is done on a system + so that the compilation works when run on a system with a different encoding. </para> diff --git a/SCons/Tool/ninja/ninja.xml b/SCons/Tool/ninja/ninja.xml index c833d44..4510f71 100644 --- a/SCons/Tool/ninja/ninja.xml +++ b/SCons/Tool/ninja/ninja.xml @@ -350,7 +350,7 @@ python -m pip install ninja <summary> <para> Internal value used to specify the function to call with argument env to generate the list of files - which if changed would require the &ninja; build file to be regenerated. + which -- if changed -- would require the &ninja; build file to be regenerated. </para> </summary> </cvar> diff --git a/SCons/Tool/packaging/packaging.xml b/SCons/Tool/packaging/packaging.xml index 0c42462..6f1a8d8 100644 --- a/SCons/Tool/packaging/packaging.xml +++ b/SCons/Tool/packaging/packaging.xml @@ -262,7 +262,7 @@ placed if applicable. The default value is <quote>&cv-NAME;-&cv-VERSION;</quote <summary> <para> Selects the package type to build when using the &b-link-Package; -builder. May be a string or list of strings. See the docuentation +builder. It may be a string or list of strings. See the documentation for the builder for the currently supported types. </para> diff --git a/SCons/Tool/qt3.xml b/SCons/Tool/qt3.xml index a2762f7..4c75a88 100644 --- a/SCons/Tool/qt3.xml +++ b/SCons/Tool/qt3.xml @@ -74,7 +74,7 @@ The &t-qt3; tool supports the following operations: <emphasis role="strong">Automatic moc file generation from header files.</emphasis> You do not have to specify moc files explicitly, the tool does it for you. However, there are a few preconditions to do so: Your header file must have -the same filebase as your implementation file and must stay in the same +the same basename as your implementation file and must stay in the same directory. It must have one of the suffixes <filename>.h</filename>, <filename>.hpp</filename>, diff --git a/SCons/Tool/tlib.xml b/SCons/Tool/tlib.xml index f186a17..1fb34ef 100644 --- a/SCons/Tool/tlib.xml +++ b/SCons/Tool/tlib.xml @@ -28,7 +28,7 @@ This file is processed by the bin/SConsDoc.py module. <summary> <para> Sets construction variables for the Borland -<application>tib</application> library archiver. +<application>tlib</application> library archiver. </para> </summary> <sets> diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 656d34c..d646185 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -2368,7 +2368,7 @@ is run with the &Python; option or from optimized &Python; (<filename>.pyo</filename>) modules.</para> <para> Note the "no-" prefix is part of the name of this warning. -Add an additional "-no" to disable. +Add another "-no" to disable. </para> </listitem> </varlistentry> @@ -2383,7 +2383,7 @@ option is used. These warnings are enabled by default.</para> <para> Note the "no-" prefix is part of the name of this warning. -Add an additional "-no" to disable. +Add another "-no" to disable. </para> </listitem> </varlistentry> @@ -2667,7 +2667,7 @@ one of the pre-defined platforms <literal>posix</literal>, <literal>sunos</literal> or <literal>win32</literal>), -or it may be a callable platform object +or a callable platform object returned by a call to &f-link-Platform; selecting a pre-defined platform, or it may be a user-supplied callable, diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml index 61dc1d8..9278fa5 100644 --- a/doc/user/build-install.xml +++ b/doc/user/build-install.xml @@ -298,7 +298,7 @@ $ <userinput>python <replaceable>/path/to/unpacked</replaceable>/scripts/scons.p of &Python; software). There is a <filename>setup.py</filename> file, but it is only tested and used for the automated procedure which prepares an &SCons; bundle for making a release on PyPI, - and even that is not guaranteed to work in future. + and even that is not guaranteed to work in the future. </para> </section> diff --git a/doc/user/command-line.xml b/doc/user/command-line.xml index c0a3c0c..5245edf 100644 --- a/doc/user/command-line.xml +++ b/doc/user/command-line.xml @@ -795,7 +795,7 @@ foo.in You may want to control various aspects of your build by allowing <varname>variable</varname>=<replaceable>value</replaceable> - values to be specified on the command line. + pairs to be specified on the command line. For example, suppose you want to be able to build a debug version of a program by running &SCons; as follows: diff --git a/doc/user/external.xml b/doc/user/external.xml index 4e021f6..e462ef0 100644 --- a/doc/user/external.xml +++ b/doc/user/external.xml @@ -34,7 +34,7 @@ This file is processed by the bin/SConsDoc.py module. Sometimes a project needs to interact with other projects in various ways. For example, many open source projects make use of components from other open source projects, - and want to use those in their released form, not recode + and want to use those in their released form, not rewrite their builds into &SCons;. As another example, sometimes the flexibility and power of &SCons; is useful for managing the overall project, but developers might like faster incremental diff --git a/doc/user/hierarchy.xml b/doc/user/hierarchy.xml index 8c6b4ca..9bce052 100644 --- a/doc/user/hierarchy.xml +++ b/doc/user/hierarchy.xml @@ -370,7 +370,7 @@ x in one pass, interpreting each in its local context, building up a tree of information, before starting to execute the needed builds in a second pass. - This is quite different than some other build tools + This is quite different from some other build tools which implement a hierarchical build by recursing. </para> diff --git a/doc/user/less-simple.xml b/doc/user/less-simple.xml index 4c1b14d..19dab6f 100644 --- a/doc/user/less-simple.xml +++ b/doc/user/less-simple.xml @@ -301,7 +301,7 @@ Program('hello', ['hello.c']) Although &SCons; functions are forgiving about whether or not you use a string vs. a list for a single file name, - &Python; itself is more strict about + &Python; itself is stricter about treating lists and strings differently. So where &SCons; allows either a string or list: diff --git a/doc/user/sideeffect.xml b/doc/user/sideeffect.xml index cff8985..c1e2433 100644 --- a/doc/user/sideeffect.xml +++ b/doc/user/sideeffect.xml @@ -47,7 +47,7 @@ This file is processed by the bin/SConsDoc.py module. will also put data into <filename>log</filename>, which is used as a source for the command to generate <filename>file2</filename>, but <filename>log</filename> is unknown to &SCons; on a clean - build: it neither exists, nor is it a target output by any builder. + build: it neither exists nor is it a target output by any builder. The <filename>SConscript</filename> uses &SideEffect; to inform &SCons; about the additional output file. |