summaryrefslogtreecommitdiff
path: root/src/engine
diff options
context:
space:
mode:
authorgrbd <garlicbready@googlemail.com>2017-08-03 12:33:51 -0700
committergrbd <garlicbready@googlemail.com>2017-08-03 12:33:51 -0700
commit89f696dfa476e26806bc92acd17e6df27440ae48 (patch)
tree86f00b955cc24fe69293f033953d2a85f43c3eb3 /src/engine
parentd8411e0cf81535f8396db5c07b73f40b28a197c6 (diff)
downloadscons-89f696dfa476e26806bc92acd17e6df27440ae48.tar.gz
Added docs for use of the PyPackageDir function
Diffstat (limited to 'src/engine')
-rw-r--r--src/engine/SCons/Environment.xml23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/engine/SCons/Environment.xml b/src/engine/SCons/Environment.xml
index 92bc21a3..ccee68d7 100644
--- a/src/engine/SCons/Environment.xml
+++ b/src/engine/SCons/Environment.xml
@@ -2504,6 +2504,29 @@ env.PrependUnique(CCFLAGS = '-g', FOO = ['foo.yyy'])
</summary>
</scons_function>
+<scons_function name="PyPackageDir">
+<arguments>
+(modulename)
+</arguments>
+<summary>
+<para>
+This returns a Directory Node similar to Dir.
+The python module / package is looked up and if located
+the directory is returned for the location.
+<varname>modulename</varname>
+Is a named python package / module to
+lookup the directory for it's location.
+</para>
+<para>
+If
+<varname>modulename</varname>
+is a list, SCons returns a list of Dir nodes.
+Construction variables are expanded in
+<varname>modulename</varname>.
+</para>
+</summary>
+</scons_function>
+
<scons_function name="Replace">
<arguments signature="env">
(key=val, [...])