diff options
author | grbd <garlicbready@googlemail.com> | 2017-06-19 15:45:03 +0100 |
---|---|---|
committer | grbd <garlicbready@googlemail.com> | 2017-06-19 15:45:03 +0100 |
commit | 96f137b8319c639937f4617920f96763e013213d (patch) | |
tree | 7ef2098233abd5e35324eb7549aefbeabb58dbcc /doc/man | |
parent | ddebfe395db6e95615df59278f99bbf64f3ddd9c (diff) | |
download | scons-96f137b8319c639937f4617920f96763e013213d.tar.gz |
Updated the documentation for nested tools located within subdirs
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/scons.xml | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/man/scons.xml b/doc/man/scons.xml index b68f27ae..3268860b 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -2187,6 +2187,22 @@ platform name when the Environment is constructed. Changing the PATH variable after the Environment is constructed will not cause the tools to be redetected.</para> +<para> One feature now present within Scons is the ability to have nested tools. +Tools which can be located within a subdirectory in the toolpath. +With a nested tool name the dot represents a directory seperator</para> + +<programlisting> +# namespaced builder +env = Environment(ENV = os.environ, tools = ['SubDir1.SubDir2.SomeTool']) +env.SomeTool(targets, sources) + +# Search Paths +# SCons\Tool\SubDir1\SubDir2\SomeTool.py +# SCons\Tool\SubDir1\SubDir2\SomeTool\__init__.py +# .\site_scons\site_tools\SubDir1\SubDir2\SomeTool.py +# .\site_scons\site_tools\SubDir1\SubDir2\SomeTool\__init__.py +</programlisting> + <para>SCons supports the following tool specifications out of the box:</para> <!-- '\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" --> |