summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2021-04-10 17:09:03 -0700
committerDaniel Moody <daniel.moody@mongodb.com>2021-06-01 16:52:54 -0500
commit1d456a8feb5fffff54364ab61b576e81d743687e (patch)
tree5f582a85b846630dfc9efc0817661e9b8845b394 /doc
parent07119cd6aa3a34813214d95b26745182929cd296 (diff)
downloadscons-git-1d456a8feb5fffff54364ab61b576e81d743687e.tar.gz
Fix ninja.xml syntax error
Diffstat (limited to 'doc')
-rw-r--r--doc/generated/builders.gen53
-rw-r--r--doc/generated/builders.mod4
-rw-r--r--doc/generated/functions.gen4
-rw-r--r--doc/generated/tools.gen7
-rw-r--r--doc/generated/tools.mod2
-rw-r--r--doc/generated/variables.gen189
-rw-r--r--doc/generated/variables.mod26
7 files changed, 265 insertions, 20 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen
index 14508ea96..d3490f0ca 100644
--- a/doc/generated/builders.gen
+++ b/doc/generated/builders.gen
@@ -1221,6 +1221,59 @@ env.MSVSSolution(
</example_commands>
</listitem>
</varlistentry>
+ <varlistentry id="b-Ninja">
+ <term><function>Ninja</function>()</term>
+ <term><replaceable>env</replaceable>.<methodname>Ninja</methodname>()</term>
+ <listitem><para>
+ &b-Ninja; is a special builder which
+ adds a target to create a ninja build file.
+ The builder does not require any source files to be specified,
+
+ </para>
+ <para>
+ If called with no arguments,
+ the builder will default to a target name of
+ <filename>ninja.build</filename>.
+ </para>
+ <para>
+ If called with a single positional argument,
+ &scons; will "deduce" the target name from that source
+ argument, giving it the same name, and then
+ ignore the source.
+ This is the usual way to call the builder if a
+ non-default target name is wanted.
+ </para>
+ <para>
+ If called with either the
+ <parameter>target=</parameter>
+ or <parameter>source=</parameter> keyword arguments,
+ the value of the argument is taken as the target name.
+ If called with both, the
+ <parameter>target=</parameter>
+ value is used and <parameter>source=</parameter> is ignored.
+ If called with multiple sources,
+ the source list will be ignored,
+ since there is no way to deduce what the intent was;
+ in this case the default target name will be used.
+ </para>
+ <note>
+ <para>
+ You must load the &t-ninja; tool prior to specifying
+ any part of your build or some source/output
+ files will not show up in the compilation database.
+ </para>
+ <para>
+ To use this tool you must install pypi's <ulink url="https://pypi.org/project/ninja/">ninja
+ package</ulink>.
+ This can be done via
+ <command>pip install ninja</command>
+ </para>
+ </note>
+ <para>
+ <emphasis>Available since &scons; 4.2.</emphasis>
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry id="b-Object">
<term><function>Object</function>()</term>
<term><replaceable>env</replaceable>.<methodname>Object</methodname>()</term>
diff --git a/doc/generated/builders.mod b/doc/generated/builders.mod
index 4835118f6..3542b9911 100644
--- a/doc/generated/builders.mod
+++ b/doc/generated/builders.mod
@@ -37,6 +37,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY b-MOFiles "<function xmlns='http://www.scons.org/dbxsd/v1.0'>MOFiles</function>">
<!ENTITY b-MSVSProject "<function xmlns='http://www.scons.org/dbxsd/v1.0'>MSVSProject</function>">
<!ENTITY b-MSVSSolution "<function xmlns='http://www.scons.org/dbxsd/v1.0'>MSVSSolution</function>">
+<!ENTITY b-Ninja "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Ninja</function>">
<!ENTITY b-Object "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Object</function>">
<!ENTITY b-Package "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Package</function>">
<!ENTITY b-PCH "<function xmlns='http://www.scons.org/dbxsd/v1.0'>PCH</function>">
@@ -94,6 +95,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY b-env-MOFiles "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.MOFiles</function>">
<!ENTITY b-env-MSVSProject "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.MSVSProject</function>">
<!ENTITY b-env-MSVSSolution "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.MSVSSolution</function>">
+<!ENTITY b-env-Ninja "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Ninja</function>">
<!ENTITY b-env-Object "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Object</function>">
<!ENTITY b-env-Package "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Package</function>">
<!ENTITY b-env-PCH "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.PCH</function>">
@@ -157,6 +159,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY b-link-MOFiles "<link linkend='b-MOFiles' xmlns='http://www.scons.org/dbxsd/v1.0'><function>MOFiles</function></link>">
<!ENTITY b-link-MSVSProject "<link linkend='b-MSVSProject' xmlns='http://www.scons.org/dbxsd/v1.0'><function>MSVSProject</function></link>">
<!ENTITY b-link-MSVSSolution "<link linkend='b-MSVSSolution' xmlns='http://www.scons.org/dbxsd/v1.0'><function>MSVSSolution</function></link>">
+<!ENTITY b-link-Ninja "<link linkend='b-Ninja' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Ninja</function></link>">
<!ENTITY b-link-Object "<link linkend='b-Object' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Object</function></link>">
<!ENTITY b-link-Package "<link linkend='b-Package' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Package</function></link>">
<!ENTITY b-link-PCH "<link linkend='b-PCH' xmlns='http://www.scons.org/dbxsd/v1.0'><function>PCH</function></link>">
@@ -214,6 +217,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY b-link-env-MOFiles "<link linkend='b-MOFiles' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.MOFiles</function></link>">
<!ENTITY b-link-env-MSVSProject "<link linkend='b-MSVSProject' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.MSVSProject</function></link>">
<!ENTITY b-link-env-MSVSSolution "<link linkend='b-MSVSSolution' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.MSVSSolution</function></link>">
+<!ENTITY b-link-env-Ninja "<link linkend='b-Ninja' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Ninja</function></link>">
<!ENTITY b-link-env-Object "<link linkend='b-Object' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Object</function></link>">
<!ENTITY b-link-env-Package "<link linkend='b-Package' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Package</function></link>">
<!ENTITY b-link-env-PCH "<link linkend='b-PCH' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.PCH</function></link>">
diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen
index 1af4baeac..cd71ee9a8 100644
--- a/doc/generated/functions.gen
+++ b/doc/generated/functions.gen
@@ -548,8 +548,8 @@ do not make sense and a Python exception will be raised.
</para>
<para>
-When using &f-env-Append; to modify &consvars;
-which are path specifications (normally,
+When using &f-env-Append; to modify &consvars;
+which are path specifications (normally,
those names which end in <varname>PATH</varname>),
it is recommended to add the values as a list of strings,
even if there is only a single string to add.
diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen
index dc15b6e5b..bdb353ce6 100644
--- a/doc/generated/tools.gen
+++ b/doc/generated/tools.gen
@@ -811,6 +811,13 @@ Sets construction variables for the
</para>
<para>Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.</para><para>Uses: &cv-link-ASCOMSTR;, &cv-link-ASPPCOMSTR;.</para></listitem>
</varlistentry>
+ <varlistentry id="t-ninja">
+ <term>ninja</term>
+ <listitem><para>
+ Sets up &b-link-Ninja; builder which generates a ninja build file, and then optionally runs ninja.
+ </para>
+ <para>Sets: &cv-link-DISABLE_AUTO_NINJA;, &cv-link-NINJA_ALIAS_NAME;, &cv-link-NINJA_BUILDDIR;, &cv-link-NINJA_COMPDB_EXPAND;, &cv-link-NINJA_ENV_VAR_CACHE;, &cv-link-NINJA_FILE_NAME;, &cv-link-NINJA_GENERATED_SOURCE_SUFFIXES;, &cv-link-NINJA_MSVC_DEPS_PREFIX;, &cv-link-NINJA_POOL;, &cv-link-NINJA_REGENERATE_DEPS;, &cv-link-NINJA_SYNTAX;, &cv-link-_NINJA_REGENERATE_DEPS_FUNC;, &cv-link-__NINJA_NO;.</para><para>Uses: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CXX;, &cv-link-CXXCOM;, &cv-link-ESCAPE;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-PLATFORM;, &cv-link-RANLIB;, &cv-link-RANLIBCOM;, &cv-link-SHCXXCOM;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;.</para></listitem>
+ </varlistentry>
<varlistentry id="t-packaging">
<term>packaging</term>
<listitem><para>
diff --git a/doc/generated/tools.mod b/doc/generated/tools.mod
index 78aa9ef98..35eea5e2b 100644
--- a/doc/generated/tools.mod
+++ b/doc/generated/tools.mod
@@ -79,6 +79,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY t-mwcc "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>mwcc</literal>">
<!ENTITY t-mwld "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>mwld</literal>">
<!ENTITY t-nasm "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>nasm</literal>">
+<!ENTITY t-ninja "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>ninja</literal>">
<!ENTITY t-packaging "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>packaging</literal>">
<!ENTITY t-pdf "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>pdf</literal>">
<!ENTITY t-pdflatex "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>pdflatex</literal>">
@@ -184,6 +185,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY t-link-mwcc "<link linkend='t-mwcc' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>mwcc</literal></link>">
<!ENTITY t-link-mwld "<link linkend='t-mwld' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>mwld</literal></link>">
<!ENTITY t-link-nasm "<link linkend='t-nasm' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>nasm</literal></link>">
+<!ENTITY t-link-ninja "<link linkend='t-ninja' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>ninja</literal></link>">
<!ENTITY t-link-packaging "<link linkend='t-packaging' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>packaging</literal></link>">
<!ENTITY t-link-pdf "<link linkend='t-pdf' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>pdf</literal></link>">
<!ENTITY t-link-pdflatex "<link linkend='t-pdflatex' xmlns='http://www.scons.org/dbxsd/v1.0'><literal>pdflatex</literal></link>">
diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen
index a24fd34ae..4d5f92f26 100644
--- a/doc/generated/variables.gen
+++ b/doc/generated/variables.gen
@@ -22,6 +22,16 @@ if &cv-link-LDMODULEVERSION; is set. Othervise it evaluates to an empty string.
</para>
</listitem>
</varlistentry>
+ <varlistentry id="cv-__NINJA_NO">
+ <term>
+ <envar>__NINJA_NO</envar>
+ </term>
+ <listitem><para>
+ Internal flag. Used to tell SCons whether or not to try to import pypi's ninja python package.
+ This is set to True when being called by Ninja?
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry id="cv-__SHLIBVERSIONFLAGS">
<term>
<envar>__SHLIBVERSIONFLAGS</envar>
@@ -703,8 +713,8 @@ the type of value of &cv-CPPDEFINES;:
If &cv-CPPDEFINES; is a string,
the values of the
&cv-link-CPPDEFPREFIX; and &cv-link-CPPDEFSUFFIX; &consvars;
-will be respectively prepended and appended to
-each definition in &cv-link-CPPDEFINES;.
+will be respectively prepended and appended to
+each definition in &cv-CPPDEFINES;.
</para>
<example_commands>
@@ -716,8 +726,8 @@ env = Environment(CPPDEFINES='xyz')
<para>
If &cv-CPPDEFINES; is a list,
the values of the
-&cv-CPPDEFPREFIX; and &cv-CPPDEFSUFFIX; &consvars;
-will be respectively prepended and appended to
+&cv-link-CPPDEFPREFIX; and &cv-link-CPPDEFSUFFIX; &consvars;
+will be respectively prepended and appended to
each element in the list.
If any element is a list or tuple,
then the first item is the name being
@@ -733,7 +743,7 @@ env = Environment(CPPDEFINES=[('B', 2), 'A'])
<para>
If &cv-CPPDEFINES; is a dictionary,
the values of the
-&cv-CPPDEFPREFIX; and &cv-CPPDEFSUFFIX; &consvars;
+&cv-link-CPPDEFPREFIX; and &cv-link-CPPDEFSUFFIX; &consvars;
will be respectively prepended and appended to
each item from the dictionary.
The key of each dictionary item
@@ -835,7 +845,7 @@ to each directory in &cv-link-CPPPATH;.
<listitem><para>
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.
+directories for include files.
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
@@ -847,11 +857,11 @@ Python's <systemitem>os.sep</systemitem>.
<para>
Note:
-directory names in &cv-CPPPATH;
+directory names in &cv-link-CPPPATH;
will be looked-up relative to the directory of the SConscript file
-when they are used in a command.
+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>
@@ -1162,6 +1172,17 @@ into a list of Dir instances relative to the target being built.
</para>
</listitem>
</varlistentry>
+ <varlistentry id="cv-DISABLE_AUTO_NINJA">
+ <term>
+ <envar>DISABLE_AUTO_NINJA</envar>
+ </term>
+ <listitem><para>
+ Boolean (True|False). Default: False
+ When True, SCons will not run ninja automatically after creating the ninja.build file.
+
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry id="cv-DLIB">
<term>
<envar>DLIB</envar>
@@ -3137,7 +3158,7 @@ The default list is:
<envar>IMPLIBNOVERSIONSYMLINKS</envar>
</term>
<listitem><para>
-Used to override &cv-link-SHLIBNOVERSIONSYMLINKS;/&cv-link-LDMODULENOVERSIONSYMLINKS; when
+Used to override &cv-link-SHLIBNOVERSIONSYMLINKS;/&cv-link-LDMODULENOVERSIONSYMLINKS; when
creating versioned import library for a shared library/loadable module. If not defined,
then &cv-link-SHLIBNOVERSIONSYMLINKS;/&cv-link-LDMODULENOVERSIONSYMLINKS; is used to determine
whether to disable symlink generation or not.
@@ -4053,9 +4074,9 @@ as the result will be non-portable.
Note:
directory names in &cv-LIBPATH; will be looked-up relative to the
directory of the SConscript file
-when they are used in a command.
+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>
@@ -4127,7 +4148,7 @@ and suffixes from the &cv-link-LIBSUFFIXES; list.
<listitem><para>
A list of one or more libraries
that will be added to the link line
-for linking with any executable program, shared library, or loadable module
+for linking with any executable program, shared library, or loadable module
created by the &consenv; or override.
</para>
@@ -4493,7 +4514,7 @@ See &t-link-msgfmt; tool and &b-link-MOFiles; builder.
<envar>MSGFMTCOMSTR</envar>
</term>
<listitem><para>
-String to display when <command>msgfmt(1)</command> is invoked
+String to display when <command>msgfmt(1)</command> is invoked
(default: <literal>''</literal>, which means ``print &cv-link-MSGFMTCOM;'').
See &t-link-msgfmt; tool and &b-link-MOFiles; builder.
</para>
@@ -4535,7 +4556,7 @@ See &t-link-msginit; tool and &b-link-POInit; builder.
<envar>MSGINITCOMSTR</envar>
</term>
<listitem><para>
-String to display when <command>msginit(1)</command> is invoked
+String to display when <command>msginit(1)</command> is invoked
(default: <literal>''</literal>, which means ``print &cv-link-MSGINITCOM;'').
See &t-link-msginit; tool and &b-link-POInit; builder.
</para>
@@ -4631,7 +4652,7 @@ Supported versions include
<literal>6.0A</literal>,
<literal>6.0</literal>,
<literal>2003R2</literal>
-and
+and
<literal>2003R1</literal>.
</para>
</listitem>
@@ -5156,6 +5177,138 @@ Specfies the name of the project to package.
<para>See the &b-link-Package; builder.</para>
</listitem>
</varlistentry>
+ <varlistentry id="cv-NINJA_ALIAS_NAME">
+ <term>
+ <envar>NINJA_ALIAS_NAME</envar>
+ </term>
+ <listitem><para>
+ Name of the Alias() which is will cause SCons to create the <filename>ninja.build</filename> file, and
+ then (optionally) run ninja.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-NINJA_BUILDDIR">
+ <term>
+ <envar>NINJA_BUILDDIR</envar>
+ </term>
+ <listitem><para>
+ This propagates directly into the generated Ninja.build file.
+ From Ninja's docs:
+ <blockquote>
+ <para>
+ builddir
+ A directory for some Ninja output files. ... (You can also store other build output in this
+ directory.)
+ </para>
+ </blockquote>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-NINJA_COMPDB_EXPAND">
+ <term>
+ <envar>NINJA_COMPDB_EXPAND</envar>
+ </term>
+ <listitem><para>
+ Boolean value (True|False) to instruct ninja to expand the command line arguments normally put into
+ response files.
+ This prevents lines in the compilation database like <quote>gcc @rsp_file</quote> and instead yields
+ <quote>gcc -c -o myfile.o myfile.c -Ia -DXYZ</quote>
+ </para>
+ <para>
+ Ninja's compdb tool added the <quote>-x</quote> flag in Ninja V1.9.0
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-NINJA_ENV_VAR_CACHE">
+ <term>
+ <envar>NINJA_ENV_VAR_CACHE</envar>
+ </term>
+ <listitem><para>
+ A string that sets the environment for any environment variables that
+ differ between the OS environment and the SCons command ENV.
+
+ It will be compatible with the default shell of the operating system.
+
+ If not explicitly specified, SCons will generate this dynamically from the Environment()'s 'ENV'
+ <quote>env['ENV']</quote>
+ where those values differ from the existing shell..
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-NINJA_FILE_NAME">
+ <term>
+ <envar>NINJA_FILE_NAME</envar>
+ </term>
+ <listitem><para>
+ The filename for the generated Ninja build file defaults to <filename>ninja.build</filename>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-NINJA_GENERATED_SOURCE_SUFFIXES">
+ <term>
+ <envar>NINJA_GENERATED_SOURCE_SUFFIXES</envar>
+ </term>
+ <listitem><para>
+ The list of source file suffixes which are generated by SCons build steps.
+ All source files which match these suffixes will be added to the _generated_sources alias in the output
+ ninja.build file.
+ Then all other source files will be made to depend on this in the Ninja.build file, forcing the
+ generated sources to be built first.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-NINJA_MSVC_DEPS_PREFIX">
+ <term>
+ <envar>NINJA_MSVC_DEPS_PREFIX</envar>
+ </term>
+ <listitem><para>
+ This propagates directly into the generated Ninja.build file.
+ From Ninja's docs
+ <quote>defines the string which should be stripped from msvc’s /showIncludes output</quote>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-NINJA_POOL">
+ <term>
+ <envar>NINJA_POOL</envar>
+ </term>
+ <listitem><para>
+ Set the <quote>ninja_pool</quote> for this or all targets in scope for this env var.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-NINJA_REGENERATE_DEPS">
+ <term>
+ <envar>NINJA_REGENERATE_DEPS</envar>
+ </term>
+ <listitem><para>
+ A generator function used to create a ninja depsfile which includes all the files which would require
+ SCons to be invoked if they change.
+ Or a list of said files.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-_NINJA_REGENERATE_DEPS_FUNC">
+ <term>
+ <envar>_NINJA_REGENERATE_DEPS_FUNC</envar>
+ </term>
+ <listitem><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 file to be regenerated.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="cv-NINJA_SYNTAX">
+ <term>
+ <envar>NINJA_SYNTAX</envar>
+ </term>
+ <listitem><para>
+ Theres also NINJA_SYNTAX which is the path to a custom ninja_syntax.py file which is used in generation.
+ The tool currently assumes you have ninja installed through pip, and grabs the syntax file from that
+ installation if none specified.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry id="cv-no_import_lib">
<term>
<envar>no_import_lib</envar>
@@ -7357,7 +7510,7 @@ for more information).
<envar>SOVERSION</envar>
</term>
<listitem><para>
-This will construct the <varname>SONAME</varname> using on the base library name
+This will construct the <varname>SONAME</varname> using on the base library name
(<parameter>test</parameter> in the example below) and use specified <varname>SOVERSION</varname>
to create <varname>SONAME</varname>.
<example_commands>
@@ -7366,7 +7519,7 @@ env.SharedLibrary('test', 'test.c', SHLIBVERSION='0.1.2', SOVERSION='2')
The variable is used, for example, by &t-link-gnulink; linker tool.
</para>
<para>
-In the example above <varname>SONAME</varname> would be <filename>libtest.so.2</filename>
+In the example above <varname>SONAME</varname> would be <filename>libtest.so.2</filename>
which would be a symlink and point to <filename>libtest.so.0.1.2</filename>
</para>
</listitem>
diff --git a/doc/generated/variables.mod b/doc/generated/variables.mod
index a3dbc0d8f..86fc604b4 100644
--- a/doc/generated/variables.mod
+++ b/doc/generated/variables.mod
@@ -9,6 +9,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
-->
<!ENTITY cv-__LDMODULEVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$__LDMODULEVERSIONFLAGS</envar>">
+<!ENTITY cv-__NINJA_NO "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$__NINJA_NO</envar>">
<!ENTITY cv-__SHLIBVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$__SHLIBVERSIONFLAGS</envar>">
<!ENTITY cv-APPLELINK_COMPATIBILITY_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$APPLELINK_COMPATIBILITY_VERSION</envar>">
<!ENTITY cv-_APPLELINK_COMPATIBILITY_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_APPLELINK_COMPATIBILITY_VERSION</envar>">
@@ -83,6 +84,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY cv-DINCSUFFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DINCSUFFIX</envar>">
<!ENTITY cv-Dir "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$Dir</envar>">
<!ENTITY cv-Dirs "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$Dirs</envar>">
+<!ENTITY cv-DISABLE_AUTO_NINJA "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DISABLE_AUTO_NINJA</envar>">
<!ENTITY cv-DLIB "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DLIB</envar>">
<!ENTITY cv-DLIBCOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DLIBCOM</envar>">
<!ENTITY cv-DLIBDIRPREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DLIBDIRPREFIX</envar>">
@@ -349,6 +351,17 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY cv-MWCW_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$MWCW_VERSION</envar>">
<!ENTITY cv-MWCW_VERSIONS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$MWCW_VERSIONS</envar>">
<!ENTITY cv-NAME "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NAME</envar>">
+<!ENTITY cv-NINJA_ALIAS_NAME "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_ALIAS_NAME</envar>">
+<!ENTITY cv-NINJA_BUILDDIR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_BUILDDIR</envar>">
+<!ENTITY cv-NINJA_COMPDB_EXPAND "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_COMPDB_EXPAND</envar>">
+<!ENTITY cv-NINJA_ENV_VAR_CACHE "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_ENV_VAR_CACHE</envar>">
+<!ENTITY cv-NINJA_FILE_NAME "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_FILE_NAME</envar>">
+<!ENTITY cv-NINJA_GENERATED_SOURCE_SUFFIXES "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_GENERATED_SOURCE_SUFFIXES</envar>">
+<!ENTITY cv-NINJA_MSVC_DEPS_PREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_MSVC_DEPS_PREFIX</envar>">
+<!ENTITY cv-NINJA_POOL "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_POOL</envar>">
+<!ENTITY cv-NINJA_REGENERATE_DEPS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_REGENERATE_DEPS</envar>">
+<!ENTITY cv-_NINJA_REGENERATE_DEPS_FUNC "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_NINJA_REGENERATE_DEPS_FUNC</envar>">
+<!ENTITY cv-NINJA_SYNTAX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$NINJA_SYNTAX</envar>">
<!ENTITY cv-no_import_lib "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$no_import_lib</envar>">
<!ENTITY cv-OBJPREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$OBJPREFIX</envar>">
<!ENTITY cv-OBJSUFFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$OBJSUFFIX</envar>">
@@ -649,6 +662,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
-->
<!ENTITY cv-link-__LDMODULEVERSIONFLAGS "<link linkend='cv-__LDMODULEVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$__LDMODULEVERSIONFLAGS</envar></link>">
+<!ENTITY cv-link-__NINJA_NO "<link linkend='cv-__NINJA_NO' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$__NINJA_NO</envar></link>">
<!ENTITY cv-link-__SHLIBVERSIONFLAGS "<link linkend='cv-__SHLIBVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$__SHLIBVERSIONFLAGS</envar></link>">
<!ENTITY cv-link-APPLELINK_COMPATIBILITY_VERSION "<link linkend='cv-APPLELINK_COMPATIBILITY_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$APPLELINK_COMPATIBILITY_VERSION</envar></link>">
<!ENTITY cv-link-_APPLELINK_COMPATIBILITY_VERSION "<link linkend='cv-_APPLELINK_COMPATIBILITY_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_APPLELINK_COMPATIBILITY_VERSION</envar></link>">
@@ -723,6 +737,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY cv-link-DINCSUFFIX "<link linkend='cv-DINCSUFFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DINCSUFFIX</envar></link>">
<!ENTITY cv-link-Dir "<link linkend='cv-Dir' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$Dir</envar></link>">
<!ENTITY cv-link-Dirs "<link linkend='cv-Dirs' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$Dirs</envar></link>">
+<!ENTITY cv-link-DISABLE_AUTO_NINJA "<link linkend='cv-DISABLE_AUTO_NINJA' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DISABLE_AUTO_NINJA</envar></link>">
<!ENTITY cv-link-DLIB "<link linkend='cv-DLIB' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DLIB</envar></link>">
<!ENTITY cv-link-DLIBCOM "<link linkend='cv-DLIBCOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DLIBCOM</envar></link>">
<!ENTITY cv-link-DLIBDIRPREFIX "<link linkend='cv-DLIBDIRPREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DLIBDIRPREFIX</envar></link>">
@@ -989,6 +1004,17 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
<!ENTITY cv-link-MWCW_VERSION "<link linkend='cv-MWCW_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$MWCW_VERSION</envar></link>">
<!ENTITY cv-link-MWCW_VERSIONS "<link linkend='cv-MWCW_VERSIONS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$MWCW_VERSIONS</envar></link>">
<!ENTITY cv-link-NAME "<link linkend='cv-NAME' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NAME</envar></link>">
+<!ENTITY cv-link-NINJA_ALIAS_NAME "<link linkend='cv-NINJA_ALIAS_NAME' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_ALIAS_NAME</envar></link>">
+<!ENTITY cv-link-NINJA_BUILDDIR "<link linkend='cv-NINJA_BUILDDIR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_BUILDDIR</envar></link>">
+<!ENTITY cv-link-NINJA_COMPDB_EXPAND "<link linkend='cv-NINJA_COMPDB_EXPAND' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_COMPDB_EXPAND</envar></link>">
+<!ENTITY cv-link-NINJA_ENV_VAR_CACHE "<link linkend='cv-NINJA_ENV_VAR_CACHE' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_ENV_VAR_CACHE</envar></link>">
+<!ENTITY cv-link-NINJA_FILE_NAME "<link linkend='cv-NINJA_FILE_NAME' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_FILE_NAME</envar></link>">
+<!ENTITY cv-link-NINJA_GENERATED_SOURCE_SUFFIXES "<link linkend='cv-NINJA_GENERATED_SOURCE_SUFFIXES' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_GENERATED_SOURCE_SUFFIXES</envar></link>">
+<!ENTITY cv-link-NINJA_MSVC_DEPS_PREFIX "<link linkend='cv-NINJA_MSVC_DEPS_PREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_MSVC_DEPS_PREFIX</envar></link>">
+<!ENTITY cv-link-NINJA_POOL "<link linkend='cv-NINJA_POOL' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_POOL</envar></link>">
+<!ENTITY cv-link-NINJA_REGENERATE_DEPS "<link linkend='cv-NINJA_REGENERATE_DEPS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_REGENERATE_DEPS</envar></link>">
+<!ENTITY cv-link-_NINJA_REGENERATE_DEPS_FUNC "<link linkend='cv-_NINJA_REGENERATE_DEPS_FUNC' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_NINJA_REGENERATE_DEPS_FUNC</envar></link>">
+<!ENTITY cv-link-NINJA_SYNTAX "<link linkend='cv-NINJA_SYNTAX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$NINJA_SYNTAX</envar></link>">
<!ENTITY cv-link-no_import_lib "<link linkend='cv-no_import_lib' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$no_import_lib</envar></link>">
<!ENTITY cv-link-OBJPREFIX "<link linkend='cv-OBJPREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$OBJPREFIX</envar></link>">
<!ENTITY cv-link-OBJSUFFIX "<link linkend='cv-OBJSUFFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$OBJSUFFIX</envar></link>">