summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCarn? Draug <carandraug+dev@gmail.com>2015-09-26 19:01:04 +0100
committerCarn? Draug <carandraug+dev@gmail.com>2015-09-26 19:01:04 +0100
commitb5e7eb1f92599801f943ad8ad568e089ec7db315 (patch)
tree0cb38260897ea073c8ebe22187a017e7c322ca6e /doc
parent17a82aa589e08b8025c80f58be1d7ad0556e31ee (diff)
downloadscons-b5e7eb1f92599801f943ad8ad568e089ec7db315.tar.gz
Add new CheckProg configure method to documentation and list of changes.
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 72dc7ff2..8d640541 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 569ab1a7..fe933f12 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>