summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2015-09-29 17:04:02 (GMT)
committerWilliam Deegan <bill@baddogconsulting.com>2015-09-29 17:04:02 (GMT)
commit22de916b1766151a0e1d2b598eec19b00607cd9a (patch)
tree6ed95a9bb7b6256864a971d90c8f099fba0f010b /doc
parent739878908fb7b8ffae09804369069ee33056dec5 (diff)
parent72d8407c28fc02cb986fa561c793e1b202e53867 (diff)
downloadSCons-22de916b1766151a0e1d2b598eec19b00607cd9a.zip
SCons-22de916b1766151a0e1d2b598eec19b00607cd9a.tar.gz
SCons-22de916b1766151a0e1d2b598eec19b00607cd9a.tar.bz2
Merged in carandraug/scons (pull request #248)
Diffstat (limited to 'doc')
-rw-r--r--doc/scons.mod1
-rw-r--r--doc/user/sconf.xml20
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/scons.mod b/doc/scons.mod
index 72dc7ff..8d64054 100644
--- a/doc/scons.mod
+++ b/doc/scons.mod
@@ -276,6 +276,7 @@
<!ENTITY CheckHeader "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckHeader</function>">
<!ENTITY CheckLib "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckLib</function>">
<!ENTITY CheckLibWithHeader "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckLibWithHeader</function>">
+<!ENTITY CheckProg "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckProg</function>">
<!ENTITY CheckType "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckType</function>">
<!ENTITY CheckTypeSize "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckTypeSize</function>">
<!ENTITY TryAction "<function xmlns='http://www.scons.org/dbxsd/v1.0'>TryAction</function>">
diff --git a/doc/user/sconf.xml b/doc/user/sconf.xml
index 569ab1a..fe933f1 100644
--- a/doc/user/sconf.xml
+++ b/doc/user/sconf.xml
@@ -304,6 +304,26 @@ scons: `.' is up to date.
</section>
<section>
+ <title>Checking for the Presence of a program</title>
+
+ <para>
+
+ Check for the presence of a program
+ by using the &CheckProg; method:
+
+ </para>
+
+ <sconstruct>
+env = Environment()
+conf = Configure(env)
+if not conf.CheckProg('foobar'):
+ print 'Unable to find the program foobar on the system'
+ Exit(1)
+env = conf.Finish()
+ </sconstruct>
+
+ </section>
+ <section>
<title>Adding Your Own Custom Checks</title>
<para>