summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2005-01-08 22:38:53 (GMT)
committerSteven Knight <knight@baldmt.com>2005-01-08 22:38:53 (GMT)
commit45fbab2ac65b196129132b736e45e419e4358899 (patch)
tree7efb9d5d344c6d7cd76ae432a075d5ac4276aace /doc
parentbda38f38df437d06ae2402869b9424a4b0bfa817 (diff)
downloadSCons-45fbab2ac65b196129132b736e45e419e4358899.zip
SCons-45fbab2ac65b196129132b736e45e419e4358899.tar.gz
SCons-45fbab2ac65b196129132b736e45e419e4358899.tar.bz2
Support 'from SConsScript import *' to allow Python modules imported by SConscript files to get at the global builders and functions more easily.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.124
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 7b34e8a..9fc5a6a 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -1257,6 +1257,15 @@ environment that consists of the tools and values that
.B scons
has determined are appropriate for the local system.
+Builder methods that can be called without an explicit
+environment may be called from custom Python modules that you
+import into an SConscript file by adding the following
+to the Python module:
+
+.ES
+from SCons.Script import *
+.EE
+
All builder methods return a list of Nodes
that represent the target or targets that will be built.
A
@@ -2203,6 +2212,14 @@ environment it looks like:
If you can call the functionality in both ways,
then both forms are listed.
+Global functions may be called from custom Python modules that you
+import into an SConscript file by adding the following
+to the Python module:
+
+.ES
+from SCons.Script import *
+.EE
+
Except where otherwise noted,
the same-named
construction environment method
@@ -4280,6 +4297,13 @@ In addition to the global functions and methods,
supports a number of Python variables
that can be used in SConscript files
to affect how you want the build to be performed.
+These variables may be accessed from custom Python modules that you
+import into an SConscript file by adding the following
+to the Python module:
+
+.ES
+from SCons.Script import *
+.EE
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP