Skip to content

Commit 4fc13f6

Browse files
committed
Adjust sconsign manpage
Following review comments, restored more descriptive names and reworded some things. Signed-off-by: Mats Wichmann <[email protected]>
1 parent 8440b07 commit 4fc13f6

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

doc/man/sconsign.xml

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ Displays the contents of one or more
4343
<firstterm>sconsign</firstterm> files,
4444
the signature/dependency database
4545
used by the &SCons; build tool.
46+
The database contains all Nodes that are known to the build,
47+
either by declaration in the build configuration,
48+
produced as side effects, or detected by inspection.
4649
</para>
4750

4851
<para>By default,
@@ -53,32 +56,38 @@ Without options,
5356
individual dependency entries are printed in the following format:</para>
5457

5558
<screen>
56-
depfile: csig timestamp length
57-
implicit_dependency_1: csig timestamp length
58-
implicit_dependency_2: csig timestamp length
59+
depfile: content-signature timestamp length
60+
implicit-dependency-1: content-signature timestamp length
61+
implicit-dependency-2: content-signature timestamp length
5962
...
60-
bactsig [action string]
63+
build-signature [action-string]
6164
</screen>
6265

6366
<para>
64-
<emphasis role="bold">csig</emphasis>
65-
is the <firstterm>content signature</firstterm>,
66-
a hash of the file's contents.
67-
<emphasis role="bold">bactsig</emphasis>
68-
is the <firstterm>build action signature</firstterm>,
69-
a hash of the command line or other build action
70-
used to build a target.
67+
<emphasis role="bold">content-signature</emphasis>
68+
is the hash of the file's contents (<firstterm>csig</firstterm>)
69+
and <emphasis role="bold">build-signature</emphasis>
70+
is the hash of the command line or other build action
71+
used to build a target (<firstterm>bactsig</firstterm>).
72+
If provided,
73+
<emphasis role="bold">action-string</emphasis>
74+
is the unexpanded string action or the function called.
7175
<emphasis role="bold">None</emphasis>
7276
is printed in place of any missing timestamp,
7377
<emphasis role="bold">csig</emphasis>,
7478
or <emphasis role="bold">bactsig</emphasis>
75-
values for any entry
76-
or any of its dependencies.
79+
values for any entry or any of its dependencies.
7780
If the entry has no implicit dependencies,
7881
or no build action,
7982
the corresponding lines are omitted.
8083
</para>
8184

85+
<para>
86+
An indicator line is printed for each directory,
87+
as directories do not have signatures in the database
88+
and so would not otherwise be shown.
89+
</para>
90+
8291
<para>
8392
By default,
8493
<command>sconsign</command>

0 commit comments

Comments
 (0)