version 3.0.2
stataconsign¶
stataconsign -- calls the SCons function sconsign to print the contents of the sconsign database, typically .sconsign.dblite, to the Stata window.
The syntax of stataconsign mimics that of sconsign. This help file reproduces the contents of the sconsign help, which can be accessed from the appropriate shell prompt with sconsign -h, and adds a few comments.
Syntax¶
stataconsign [OPTIONS] [FILE ...]
By default, stataconsign will look in the current directory for an file sconsign.dblite and print the contents of that database to the Stata window.
Options¶
Option |
Description |
|---|---|
-a, --act, --action |
Print build action information. |
-c, --csig |
Print content signature information. |
-d DIR, --dir=DIR |
Print only info about DIR. |
-e ENTRY, --entry=ENTRY |
Print only info about ENTRY. |
-f FORMAT, --format=FORMAT |
FILE is in the specified FORMAT. |
-h, --help |
Print this message and exit. |
-i, --implicit |
Print implicit dependency information. |
-r, --readable |
Print timestamps in human-readable form. |
--raw |
Print raw Python object representations. |
-s, --size |
Print file sizes. |
-t, --timestamp |
Print timestamp information. |
-v, --verbose |
Verbose, describe each field. |
Remarks¶
stataconsign is useful for obtaining information on what SCons considers to be the most recent build, i.e., the last time the project was built by SCons.
Examples¶
basic use
. stataconsign
use human-readable timestamps
. stataconsign -r
examine a database named .sconsignParallel.dblite in a sub-directory dbs
. stataconsign dbs/.sconsignParallel.dblite
Advanced Use¶
Use the SConsignFile() function in an SConstruct to specify a filename and directory for the sconsign database associated with that SConstruct. For example:
SConsignFile("dbs/.sconsignParallel.dblite")
See the SCons User Manual and SCons Man Page for more details.
From a shell prompt, the screen output of sconsign can be saved to a text file as follows:
sconsign > sconsign.txt
References¶
SCons Development Team (2021a), SCons 4.3.0 Man page, https://scons.org/doc/4.3.0/PDF/scons-man.pdf
SCons Development Team (2021b), SCons 4.3.0 User Guide, https://scons.org/doc/4.3.0/PDF/scons-user.pdf
This help file was dynamically produced by MarkDoc Literate Programming package