Regenerated docs for 4.2.0 release.

3 files changed, 54 insertions, 27 deletions

diff --git a/doc/generated/examples/caching_ex-random_1.xml b/doc/generated/examples/caching_ex-random_1.xml
index cc69bf166..2ec6feef3 100644
--- a/doc/generated/examples/caching_ex-random_1.xml
+++ b/doc/generated/examples/caching_ex-random_1.xml
@@ -1,8 +1,8 @@
 <screen xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput>
 cc -o f1.o -c f1.c
-cc -o f4.o -c f4.c
 cc -o f3.o -c f3.c
 cc -o f2.o -c f2.c
+cc -o f4.o -c f4.c
 cc -o f5.o -c f5.c
 cc -o prog f1.o f2.o f3.o f4.o f5.o
 </screen>
diff --git a/doc/generated/examples/troubleshoot_explain1_3.xml b/doc/generated/examples/troubleshoot_explain1_3.xml
index 6b90e1cab..ffe5d1add 100644
--- a/doc/generated/examples/troubleshoot_explain1_3.xml
+++ b/doc/generated/examples/troubleshoot_explain1_3.xml
@@ -2,5 +2,5 @@
 cp file.in file.oout
 
 scons: warning: Cannot find target file.out after building
-File "/Users/bdbaddog/devel/scons/git/as_scons/scripts/scons.py", line 96, in &lt;module&gt;
+File "/Users/bdbaddog/devel/scons/git/as_scons/scripts/scons.py", line 98, in &lt;module&gt;
 </screen>
diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen
index 064f0e36b..29b06b239 100644
--- a/doc/generated/variables.gen
+++ b/doc/generated/variables.gen
@@ -5322,11 +5322,11 @@ Specfies the name of the project to package.
     <listitem><para>
 When set to non-zero,
 suppresses creation of a corresponding Windows static import lib by the
-<literal>SharedLibrary</literal>
+&b-link-SharedLibrary;
 builder when used with
 MinGW, Microsoft Visual Studio or Metrowerks.
 This also suppresses creation
-of an export (.exp) file
+of an export (<filename>.exp</filename>) file
 when using Microsoft Visual Studio.
 </para>
 </listitem>
@@ -6320,8 +6320,8 @@ searching the repositories.
     <listitem><para>
 The program used on Windows systems
 to register a newly-built DLL library
-whenever the &b-SharedLibrary; builder
-is passed a keyword argument of <literal>register=1</literal>.
+whenever the &b-link-SharedLibrary; builder
+is passed a keyword argument of <literal>register=True</literal>.
 </para>
 </listitem>
   </varlistentry>
@@ -6332,8 +6332,8 @@ is passed a keyword argument of <literal>register=1</literal>.
     <listitem><para>
 The command line used on Windows systems
 to register a newly-built DLL library
-whenever the &b-SharedLibrary; builder
-is passed a keyword argument of <literal>register=1</literal>.
+whenever the &b-link-SharedLibrary; builder
+is passed a keyword argument of <literal>register=True</literal>.
 </para>
 </listitem>
   </varlistentry>
@@ -8250,11 +8250,13 @@ and also before &f-link-env-Tool; is called to ininitialize any of those tools:
       <envar>WINDOWS_EMBED_MANIFEST</envar>
     </term>
     <listitem><para>
-Set this variable to True or 1 to embed the compiler-generated manifest
+Set to <constant>True</constant> to embed the
+compiler-generated manifest
 (normally <literal>${TARGET}.manifest</literal>)
-into all Windows exes and DLLs built with this environment,
+into all Windows executables and DLLs built with this environment,
 as a resource during their link step.
 This is done using &cv-link-MT; and &cv-link-MTEXECOM; and &cv-link-MTSHLIBCOM;.
+See also &cv-link-WINDOWS_INSERT_MANIFEST;.
 </para>
 </listitem>
   </varlistentry>
@@ -8263,14 +8265,21 @@ This is done using &cv-link-MT; and &cv-link-MTEXECOM; and &cv-link-MTSHLIBCOM;.
       <envar>WINDOWS_INSERT_DEF</envar>
     </term>
     <listitem><para>
-When this is set to true,
+If set to true,
 a library build of a Windows shared library
 (<filename>.dll</filename> file)
-will also build a corresponding <filename>.def</filename> file
-at the same time,
-if a <filename>.def</filename> file
+will include a reference to the corresponding
+module-definition file at the same time,
+if a module-definition file
 is not already listed as a build target.
-The default is 0 (do not build a <filename>.def</filename> file).
+The name of the module-definition file will
+be constructed from the base name of the library
+and the &consvars;
+&cv-link-WINDOWSDEFSUFFIX; and
+&cv-link-WINDOWSDEFPREFIX;.
+The default is to not add a module-definition file.
+The module-definition file is not created by this directive,
+and must be supplied by the developer.
 </para>
 </listitem>
   </varlistentry>
@@ -8279,11 +8288,21 @@ The default is 0 (do not build a <filename>.def</filename> file).
       <envar>WINDOWS_INSERT_MANIFEST</envar>
     </term>
     <listitem><para>
-When this is set to true,
+If set to true,
 &scons;
-will be aware of the
-<filename>.manifest</filename>
-files generated by Microsoft Visua C/C++ 8.
+will add the manifest file
+generated by Microsoft Visual C++ 8.0 and later
+to the target list so &SCons; will be aware they
+were generated.
+In the case of an executable, the manifest file name
+is constructed using
+&cv-link-WINDOWSPROGMANIFESTSUFFIX; and
+&cv-link-WINDOWSPROGMANIFESTPREFIX;.
+In the case of a shared library, the manifest file name
+is constructed using
+&cv-link-WINDOWSSHLIBMANIFESTSUFFIX; and
+&cv-link-WINDOWSSHLIBMANIFESTPREFIX;.
+See also &cv-link-WINDOWS_EMBED_MANIFEST;.
 </para>
 </listitem>
   </varlistentry>
@@ -8292,7 +8311,8 @@ files generated by Microsoft Visua C/C++ 8.
       <envar>WINDOWSDEFPREFIX</envar>
     </term>
     <listitem><para>
-The prefix used for Windows <filename>.def</filename> file names.
+The prefix used for a Windows linker module-definition file name.
+Defaults to empty.
 </para>
 </listitem>
   </varlistentry>
@@ -8301,7 +8321,8 @@ The prefix used for Windows <filename>.def</filename> file names.
       <envar>WINDOWSDEFSUFFIX</envar>
     </term>
     <listitem><para>
-The suffix used for Windows <filename>.def</filename> file names.
+The suffix used for a Windows linker module-definition file name.
+Defaults to <filename>.def</filename>.
 </para>
 </listitem>
   </varlistentry>
@@ -8310,7 +8331,8 @@ The suffix used for Windows <filename>.def</filename> file names.
       <envar>WINDOWSEXPPREFIX</envar>
     </term>
     <listitem><para>
-The prefix used for Windows <filename>.exp</filename> file names.
+The prefix used for Windows linker exports file names.
+Defaults to empty.
 </para>
 </listitem>
   </varlistentry>
@@ -8319,7 +8341,8 @@ The prefix used for Windows <filename>.exp</filename> file names.
       <envar>WINDOWSEXPSUFFIX</envar>
     </term>
     <listitem><para>
-The suffix used for Windows <filename>.exp</filename> file names.
+The suffix used for Windows linker exports file names.
+Defaults to <filename>.exp</filename>.
 </para>
 </listitem>
   </varlistentry>
@@ -8328,8 +8351,9 @@ The suffix used for Windows <filename>.exp</filename> file names.
       <envar>WINDOWSPROGMANIFESTPREFIX</envar>
     </term>
     <listitem><para>
-The prefix used for executable program <filename>.manifest</filename> files
+The prefix used for executable program manifest files
 generated by Microsoft Visual C/C++.
+Defaults to empty.
 </para>
 </listitem>
   </varlistentry>
@@ -8338,8 +8362,9 @@ generated by Microsoft Visual C/C++.
       <envar>WINDOWSPROGMANIFESTSUFFIX</envar>
     </term>
     <listitem><para>
-The suffix used for executable program <filename>.manifest</filename> files
+The suffix used for executable program manifest files
 generated by Microsoft Visual C/C++.
+Defaults to <filename>.manifest</filename>.
 </para>
 </listitem>
   </varlistentry>
@@ -8348,8 +8373,9 @@ generated by Microsoft Visual C/C++.
       <envar>WINDOWSSHLIBMANIFESTPREFIX</envar>
     </term>
     <listitem><para>
-The prefix used for shared library <filename>.manifest</filename> files
+The prefix used for shared library manifest files
 generated by Microsoft Visual C/C++.
+Defaults to empty.
 </para>
 </listitem>
   </varlistentry>
@@ -8358,8 +8384,9 @@ generated by Microsoft Visual C/C++.
       <envar>WINDOWSSHLIBMANIFESTSUFFIX</envar>
     </term>
     <listitem><para>
-The suffix used for shared library <filename>.manifest</filename> files
+The suffix used for shared library manifest files
 generated by Microsoft Visual C/C++.
+Defaults to <filename>.manifest</filename>.
 </para>
 </listitem>
   </varlistentry>