Add the generated function documentation to the User's Guide as an appendix.

Fixes and refactoring in the bin/scons-proc.py script to support this.
Fixes to various parts of the XML input.

3 files changed, 97 insertions, 102 deletions

diff --git a/src/engine/SCons/Environment.xml b/src/engine/SCons/Environment.xml
index a86b984..b5e7026 100644
--- a/src/engine/SCons/Environment.xml
+++ b/src/engine/SCons/Environment.xml
@@ -897,7 +897,7 @@ to be performed:
 <variablelist>
 <varlistentry>
 <term>timestamp-newer</term>
-<listitem>
+<listitem><para>
 Specifies that a target shall be considered out of date and rebuilt
 if the dependency's timestamp is newer than the target file's timestamp.
 This is the behavior of the classic Make utility,
@@ -905,12 +905,11 @@ and
 <literal>make</literal>
 can be used a synonym for
 <literal>timestamp-newer</literal>.
-</listitem>
+</para></listitem>
 </varlistentry>
-
 <varlistentry>
 <term>timestamp-match</term>
-<listitem>
+<listitem><para>
 Specifies that a target shall be considered out of date and rebuilt
 if the dependency's timestamp is different than the
 timestamp recorded the last time the target was built.
@@ -921,12 +920,11 @@ except that the target will also be rebuilt if a
 dependency file has been restored to a version with an
 <emphasis>earlier</emphasis>
 timestamp, such as can happen when restoring files from backup archives.
-</listitem>
+</para></listitem>
 </varlistentry>
-
 <varlistentry>
 <term>MD5</term>
-<listitem>
+<listitem><para>
 Specifies that a target shall be considered out of date and rebuilt
 if the dependency's content has changed sine the last time
 the target was built,
@@ -937,12 +935,11 @@ last time the target was built.
 <literal>content</literal>
 can be used as a synonym for
 <literal>MD5</literal>.
-</listitem>
+</para></listitem>
 </varlistentry>
-
 <varlistentry>
 <term>MD5-timestamp</term>
-<listitem>
+<listitem><para>
 Specifies that a target shall be considered out of date and rebuilt
 if the dependency's content has changed sine the last time
 the target was built,
@@ -966,7 +963,7 @@ that runs a build,
 updates a file,
 and runs the build again,
 all within a single second.
-</listitem>
+</para></listitem>
 </varlistentry>
 </variablelist>
 
@@ -990,7 +987,7 @@ that takes the following three arguments:
 <variablelist>
 <varlistentry>
 <term><parameter>dependency</parameter></term>
-<listitem>
+<listitem><para>
 The Node (file) which
 should cause the
 <varname>target</varname>
@@ -998,24 +995,22 @@ to be rebuilt
 if it has "changed" since the last tme
 <varname>target</varname>
 was built.
-</listitem>
+</para></listitem>
 </varlistentry>
-
 <varlistentry>
 <term><parameter>target</parameter></term>
-<listitem>
+<listitem><para>
 The Node (file) being built.
 In the normal case,
 this is what should get rebuilt
 if the
 <varname>dependency</varname>
 has "changed."
-</listitem>
+</para></listitem>
 </varlistentry>
-
 <varlistentry>
 <term><parameter>prev_ni</parameter></term>
-<listitem>
+<listitem><para>
 Stored information about the state of the
 <varname>dependency</varname>
 the last time the
@@ -1025,7 +1020,7 @@ This can be consulted to match various
 file characteristics
 such as the timestamp,
 size, or content signature.
-</listitem>
+</para></listitem>
 </varlistentry>
 </variablelist>
 
@@ -2681,11 +2676,11 @@ keyword arguments
 must be set to lists of
 target and source nodes, respectively,
 if you want the
-&TARGET;,
-&TARGETS;,
-&SOURCE;
+&cv-TARGET;,
+&cv-TARGETS;,
+&cv-SOURCE;
 and
-&SOURCES;
+&cv-SOURCES;
 to be available for expansion.
 This is usually necessary if you are
 calling
diff --git a/src/engine/SCons/Script/Main.xml b/src/engine/SCons/Script/Main.xml
index bb46824..0380755 100644
--- a/src/engine/SCons/Script/Main.xml
+++ b/src/engine/SCons/Script/Main.xml
@@ -229,183 +229,183 @@ The options supported are:
 <variablelist>
 <varlistentry>
 <term><literal>cache_debug</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --cache-debug;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>cache_disable</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --cache-disable;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>cache_force</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --cache-force;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>cache_show</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --cache-show;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>clean</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -c, --clean and --remove;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>config</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --config;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>directory</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -C and --directory;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>diskcheck</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --diskcheck
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>duplicate</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --duplicate;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>file</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -f, --file, --makefile and --sconstruct;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>help</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -h and --help;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>ignore_errors</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --ignore-errors;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>implicit_cache</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --implicit-cache;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>implicit_deps_changed</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --implicit-deps-changed;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>implicit_deps_unchanged</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --implicit-deps-unchanged;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>interactive</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --interact and --interactive;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>keep_going</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -k and --keep-going;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>max_drift</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --max-drift;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>no_exec</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -n, --no-exec, --just-print, --dry-run and --recon;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>no_site_dir</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --no-site-dir;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>num_jobs</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -j and --jobs;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>profile_file</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --profile;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>question</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -q and --question;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>random</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --random;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>repository</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -Y, --repository and --srcdir;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>silent</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -s, --silent and --quiet;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>site_dir</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --site-dir;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>stack_size</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --stack-size;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>taskmastertrace_file</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --taskmastertrace; and
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>warn</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --warn and --warning.
-</listitem>
+</para></listitem>
 </varlistentry>
 </variablelist>
 
@@ -565,57 +565,57 @@ line options from a SConscript file. The options supported are:
 <variablelist>
 <varlistentry>
 <term><literal>clean</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -c, --clean and --remove;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>duplicate</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --duplicate;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>help</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -h and --help;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>implicit_cache</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --implicit-cache;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>max_drift</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --max-drift;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>no_exec</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -n, --no-exec, --just-print, --dry-run and --recon;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>num_jobs</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to -j and --jobs;
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>random</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --random; and
-</listitem>
+</para></listitem>
 </varlistentry>
 <varlistentry>
 <term><literal>stack_size</literal></term>
-<listitem>
+<listitem><para>
 which corresponds to --stack-size.
-</listitem>
+</para></listitem>
 </varlistentry>
 </variablelist>
 
diff --git a/src/engine/SCons/Tool/packaging/__init__.xml b/src/engine/SCons/Tool/packaging/__init__.xml
index 6fec7bd..246b9ec 100644
--- a/src/engine/SCons/Tool/packaging/__init__.xml
+++ b/src/engine/SCons/Tool/packaging/__init__.xml
@@ -633,7 +633,7 @@ TODO
 <summary>
 Annotates file or directory Nodes with
 information about how the
-&f-link-Package;
+&b-link-Package;
 Builder should package those files or directories.
 All tags are optional.