summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2003-09-02 03:11:08 (GMT)
committerSteven Knight <knight@baldmt.com>2003-09-02 03:11:08 (GMT)
commitf1d7f1dc87300ea5c905c648c39aeee031100c8c (patch)
treea2c5f530c8b783381fb7b1aec8a2ef1590936abe /doc
parentdc59d7046d9705c6b6f7bd6aa88a6a8b620c66f2 (diff)
downloadSCons-f1d7f1dc87300ea5c905c648c39aeee031100c8c.zip
SCons-f1d7f1dc87300ea5c905c648c39aeee031100c8c.tar.gz
SCons-f1d7f1dc87300ea5c905c648c39aeee031100c8c.tar.bz2
Support using a single .sconsign file. (Stephen Kennedy)
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.135
-rw-r--r--doc/man/sconsign.176
2 files changed, 101 insertions, 10 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 22cedab..490975d 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -31,7 +31,7 @@
.RE
.fi
..
-.TH SCONS 1 "June 2003"
+.TH SCONS 1 "September 2003"
.SH NAME
scons \- a software construction tool
.SH SYNOPSIS
@@ -4730,6 +4730,39 @@ Return(["foo", "bar"])
.EE
.TP
+.RI SConsignFile([ file ])
+This tells
+.B scons
+to store all file signatures
+in the specified
+.IR file .
+If the
+.I file
+is omitted,
+.B .sconsign.dbm
+is used by default.
+If
+.I file
+is not an absolute path name,
+the file is placed in the same directory as the top-level
+.B SConstruct
+file.
+Examples:
+
+.ES
+# Stores signatures in ".sconsign.dbm"
+# in the top-level SConstruct directory.
+SConsignFile()
+
+# Stores signatures in the file "etc/scons-signatures"
+# relative to the top-level SConstruct directory.
+SConsignFile("etc/scons-signatures")
+
+# Stores signatures in the specified absolute file name.
+SConsignFile("/home/me/SCons/signatures")
+.EE
+
+.TP
.RI SetOption( name ", " value )
This function provides a way to set a select subset of the scons command
line options from a SConscript file. The options supported are: clean which
diff --git a/doc/man/sconsign.1 b/doc/man/sconsign.1
index d5f7140..079e7ff 100644
--- a/doc/man/sconsign.1
+++ b/doc/man/sconsign.1
@@ -31,7 +31,7 @@
.RE
.fi
..
-.TH SCONSIGN 1 "July 2003"
+.TH SCONSIGN 1 "September 2003"
.SH NAME
sconsign \- print SCons .sconsign file information
.SH SYNOPSIS
@@ -66,17 +66,40 @@ is printed.
If the entry has no implicit dependencies,
the lines are simply omitted.
+By default,
+.B sconsign
+assumes that any
+.I file
+arguments that end with a
+.B .dbm
+suffix contains
+signature entries for
+more than one directory
+(that is,
+was specified by the
+.B SConsignFile ()
+function).
+Any
+.I file
+argument that does not end in
+.B .dbm
+is assumed to be a traditional
+.B .sconsign
+file containing the signature entries
+for a single directory.
+An explicit format
+may be specified using the
+.B -f
+or
+.B --file=
+options.
+
.SH OPTIONS
Various options control what information is printed
and the format:
.TP
--b
-Ignored for compatibility with non-GNU versions of
-.BR make.
-
-.TP
-b, --bsig
Prints the build signature (bsig) information
for all entries or the specified entries.
@@ -87,14 +110,49 @@ Prints the content signature (csig) information
for all entries or the specified entries.
.TP
--e entry, --entry=entry
-Prints information about only the specified entry.
+-d DIRECTORY, --dir=DIRECTORY
+When the signatures are being
+read from a
+.B .dbm
+file, or the
+.B -f dbm
+or
+.B --format=dbm
+options are used,
+prints information about
+only the signatures
+for entries in the specified
+.IR DIRECTORY .
+
+.TP
+-e ENTRY, --entry=ENTRY
+Prints information about only the specified
+.IR ENTRY .
Multiple -e options may be used,
in which case information about each
-entry is printed in the order in which the
+.I ENTRY
+is printed in the order in which the
options are specified on the command line.
.TP
+-f FORMAT, --format=FORMAT
+The file(s) to be printed
+are in the specified
+.IR FORMAT .
+Legal values are
+.B dbm
+(the DBM format used
+when the
+.BR SConsignFile ()
+function is used)
+or
+.B sconsign
+(the default format
+used for an individual
+.B .sconsign
+file in each directory).
+
+.TP
-h, --help
Prints a help message and exits.