summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2022-02-10 14:35:30 (GMT)
committerMats Wichmann <mats@linux.com>2022-02-10 14:35:30 (GMT)
commit610a3026779747c6838cd6638e238231e4e99b27 (patch)
tree887af1dfba1fc83ea4480862a1f7ee4b57de5ea5 /doc
parentf21adf30aaa4412a3524b91dbbbb7681772e705e (diff)
downloadSCons-610a3026779747c6838cd6638e238231e4e99b27.zip
SCons-610a3026779747c6838cd6638e238231e4e99b27.tar.gz
SCons-610a3026779747c6838cd6638e238231e4e99b27.tar.bz2
Use entity for content signature [ci skip]
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/scons.mod5
-rw-r--r--doc/user/depends.xml14
2 files changed, 10 insertions, 9 deletions
diff --git a/doc/scons.mod b/doc/scons.mod
index 6a2fd6b..5579d4d 100644
--- a/doc/scons.mod
+++ b/doc/scons.mod
@@ -450,8 +450,9 @@
<!ENTITY Nodes "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>Nodes</literal>">
-<!ENTITY signature "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>signature</literal>">
-<!ENTITY buildsignature "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>build signature</literal>">
+<!ENTITY contentsig "<phrase xmlns='http://www.scons.org/dbxsd/v1.0'>content signature</phrase>">
+<!ENTITY contentsigs "<phrase xmlns='http://www.scons.org/dbxsd/v1.0'>content signatures</phrase>">
+<!ENTITY buildsig "<phrase xmlns='http://www.scons.org/dbxsd/v1.0'>build signature</phrase>">
<!ENTITY true "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>true</literal>">
<!ENTITY false "<literal xmlns='http://www.scons.org/dbxsd/v1.0'>false</literal>">
diff --git a/doc/user/depends.xml b/doc/user/depends.xml
index d3f80aa..62b6d91 100644
--- a/doc/user/depends.xml
+++ b/doc/user/depends.xml
@@ -110,7 +110,7 @@ int main() { printf("Hello, world!\n"); }
so that the built software is up to date.
By default,
&SCons; keeps track of this through a
- <firstterm>content signature</firstterm>,
+ <firstterm>&contentsig;</firstterm>,
or hash, of the contents of each file,
although you can easily configure
&SCons; to use the
@@ -169,7 +169,7 @@ int main() { printf("Hello, world!\n"); }
Note that you can, if you wish,
specify the default behavior of using
- content signatures explicitly,
+ &contentsigs; explicitly,
using the &f-link-Decider; function as follows:
</para>
@@ -194,7 +194,7 @@ Decider('content')
<para>
- Using content signatures to decide if an input file has changed
+ Using &contentsigs; to decide if an input file has changed
has one surprising benefit:
if a source file has been changed
in such a way that the contents of the
@@ -391,7 +391,7 @@ int main() { printf("Hello, world!\n"); }
As a performance enhancement,
&SCons; provides a way to use
- a file's content signature,
+ a file's &contentsig;,
but to read those contents
only when the file's timestamp has changed.
To do this, call the &f-link-Decider;
@@ -552,7 +552,7 @@ int main() { printf("Hello, world!\n"); }
The third argument, <varname>prev_ni</varname>,
is an object that holds the
- signature or timestamp information
+ &contentsig; and/or timestamp information
that was recorded about the dependency
the last time the target was built.
A <varname>prev_ni</varname> object can hold
@@ -572,7 +572,7 @@ int main() { printf("Hello, world!\n"); }
<listitem>
<para>
- The <emphasis>content signature</emphasis>:
+ The &contentsig;:
a cryptgraphic hash, or checksum, of the file contents
of the <varname>dependency</varname>
file the last time the &target; was built.
@@ -705,7 +705,7 @@ env.Install("install", "test.txt")
<para>
For example, if we arbitrarily want to build
- one program using content signatures
+ one program using &contentsigs;
and another using file modification times
from the same source
we might configure it this way: