summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2010-08-02 13:21:04 (GMT)
committerSteven Knight <knight@baldmt.com>2010-08-02 13:21:04 (GMT)
commitecaa97dbf0b3c4d4b19efd23716d851b0e7a0e85 (patch)
tree4eb5179c08b1ac64708e45897460614da7488626 /src/engine/SCons
parent4a8a80541afe09ac3e084b95c3c4dbe94de6b5ef (diff)
downloadSCons-ecaa97dbf0b3c4d4b19efd23716d851b0e7a0e85.zip
SCons-ecaa97dbf0b3c4d4b19efd23716d851b0e7a0e85.tar.gz
SCons-ecaa97dbf0b3c4d4b19efd23716d851b0e7a0e85.tar.bz2
Fix <variablelist> formatting in some new function definitions: make some
overlooked terms <literal>, and rearrange tags so the regular expression substitution in bin/scons-proc.py match them.
Diffstat (limited to 'src/engine/SCons')
-rw-r--r--src/engine/SCons/Environment.xml50
-rw-r--r--src/engine/SCons/Script/Main.xml234
2 files changed, 188 insertions, 96 deletions
diff --git a/src/engine/SCons/Environment.xml b/src/engine/SCons/Environment.xml
index b2be10d..601cc56 100644
--- a/src/engine/SCons/Environment.xml
+++ b/src/engine/SCons/Environment.xml
@@ -907,8 +907,9 @@ to be performed:
<variablelist>
<varlistentry>
-<term>timestamp-newer</term>
-<listitem><para>
+<term><literal>timestamp-newer</literal></term>
+<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,
@@ -916,11 +917,13 @@ and
<literal>make</literal>
can be used a synonym for
<literal>timestamp-newer</literal>.
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
-<term>timestamp-match</term>
-<listitem><para>
+<term><literal>timestamp-match</literal></term>
+<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.
@@ -931,11 +934,13 @@ 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.
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
-<term>MD5</term>
-<listitem><para>
+<term><literal>MD5</literal></term>
+<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,
@@ -946,11 +951,13 @@ last time the target was built.
<literal>content</literal>
can be used as a synonym for
<literal>MD5</literal>.
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
-<term>MD5-timestamp</term>
-<listitem><para>
+<term><literal>MD5-timestamp</literal></term>
+<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,
@@ -974,7 +981,8 @@ that runs a build,
updates a file,
and runs the build again,
all within a single second.
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
</variablelist>
@@ -998,7 +1006,8 @@ that takes the following three arguments:
<variablelist>
<varlistentry>
<term><parameter>dependency</parameter></term>
-<listitem><para>
+<listitem>
+<para>
The Node (file) which
should cause the
<varname>target</varname>
@@ -1006,22 +1015,26 @@ to be rebuilt
if it has "changed" since the last tme
<varname>target</varname>
was built.
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><parameter>target</parameter></term>
-<listitem><para>
+<listitem>
+<para>
The Node (file) being built.
In the normal case,
this is what should get rebuilt
if the
<varname>dependency</varname>
has "changed."
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><parameter>prev_ni</parameter></term>
-<listitem><para>
+<listitem>
+<para>
Stored information about the state of the
<varname>dependency</varname>
the last time the
@@ -1031,7 +1044,8 @@ This can be consulted to match various
file characteristics
such as the timestamp,
size, or content signature.
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
</variablelist>
diff --git a/src/engine/SCons/Script/Main.xml b/src/engine/SCons/Script/Main.xml
index 0380755..d4931f1 100644
--- a/src/engine/SCons/Script/Main.xml
+++ b/src/engine/SCons/Script/Main.xml
@@ -229,183 +229,243 @@ The options supported are:
<variablelist>
<varlistentry>
<term><literal>cache_debug</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --cache-debug;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>cache_disable</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --cache-disable;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>cache_force</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --cache-force;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>cache_show</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --cache-show;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>clean</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -c, --clean and --remove;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>config</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --config;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>directory</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -C and --directory;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>diskcheck</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --diskcheck
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>duplicate</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --duplicate;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>file</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -f, --file, --makefile and --sconstruct;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>help</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -h and --help;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>ignore_errors</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --ignore-errors;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>implicit_cache</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --implicit-cache;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>implicit_deps_changed</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --implicit-deps-changed;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>implicit_deps_unchanged</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --implicit-deps-unchanged;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>interactive</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --interact and --interactive;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>keep_going</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -k and --keep-going;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>max_drift</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --max-drift;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>no_exec</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -n, --no-exec, --just-print, --dry-run and --recon;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>no_site_dir</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --no-site-dir;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>num_jobs</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -j and --jobs;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>profile_file</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --profile;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>question</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -q and --question;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>random</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --random;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>repository</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -Y, --repository and --srcdir;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>silent</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -s, --silent and --quiet;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>site_dir</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --site-dir;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>stack_size</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --stack-size;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>taskmastertrace_file</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --taskmastertrace; and
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>warn</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --warn and --warning.
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
</variablelist>
@@ -565,57 +625,75 @@ line options from a SConscript file. The options supported are:
<variablelist>
<varlistentry>
<term><literal>clean</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -c, --clean and --remove;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>duplicate</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --duplicate;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>help</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -h and --help;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>implicit_cache</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --implicit-cache;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>max_drift</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --max-drift;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>no_exec</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -n, --no-exec, --just-print, --dry-run and --recon;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>num_jobs</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to -j and --jobs;
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>random</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --random; and
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
<varlistentry>
<term><literal>stack_size</literal></term>
-<listitem><para>
+<listitem>
+<para>
which corresponds to --stack-size.
-</para></listitem>
+</para>
+</listitem>
</varlistentry>
</variablelist>