diff options
author | grbd <garlicbready@googlemail.com> | 2017-08-03 19:33:51 (GMT) |
---|---|---|
committer | grbd <garlicbready@googlemail.com> | 2017-08-03 19:33:51 (GMT) |
commit | 89091bfadcb56defc897acfa9753470e1eead6a2 (patch) | |
tree | 86f00b955cc24fe69293f033953d2a85f43c3eb3 /src | |
parent | 1849ff611b22a55b8933dc9f05db66114e34cd14 (diff) | |
download | SCons-89091bfadcb56defc897acfa9753470e1eead6a2.zip SCons-89091bfadcb56defc897acfa9753470e1eead6a2.tar.gz SCons-89091bfadcb56defc897acfa9753470e1eead6a2.tar.bz2 |
Added docs for use of the PyPackageDir function
Diffstat (limited to 'src')
-rw-r--r-- | src/CHANGES.txt | 1 | ||||
-rw-r--r-- | src/engine/SCons/Environment.xml | 23 |
2 files changed, 24 insertions, 0 deletions
diff --git a/src/CHANGES.txt b/src/CHANGES.txt index d032949..e875a01 100644 --- a/src/CHANGES.txt +++ b/src/CHANGES.txt @@ -20,6 +20,7 @@ may cause rebuilds. In no case should rebuilds not happen. - Added a small fix to the python3 tool loader when loading a tool as a package - Added additional documentation to the user manual on using toolpaths with the environment This includes the use of sys.path to search for tools installed via pip or package managers + - Added support for a PyPackageDir function for use with the toolpath From William Blevins: - Updated D language scanner support to latest: 2.071.1. (PR #1924) diff --git a/src/engine/SCons/Environment.xml b/src/engine/SCons/Environment.xml index 92bc21a..ccee68d 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, [...]) |