diff options
author | Steven Knight <knight@baldmt.com> | 2010-01-11 16:47:36 (GMT) |
---|---|---|
committer | Steven Knight <knight@baldmt.com> | 2010-01-11 16:47:36 (GMT) |
commit | a62d7407d4db87ca70a74b659cd947fedbd84d16 (patch) | |
tree | 53f7150e9dcb92ab6060c845417212a9b267ac7c /doc/user/builders-writing.in | |
parent | ebf6882d790093652da274d22c17d849a1236d4b (diff) | |
download | SCons-a62d7407d4db87ca70a74b659cd947fedbd84d16.zip SCons-a62d7407d4db87ca70a74b659cd947fedbd84d16.tar.gz SCons-a62d7407d4db87ca70a74b659cd947fedbd84d16.tar.bz2 |
Propagate doc about site_scons to builders-writing.xml. Typographic edits.
Diffstat (limited to 'doc/user/builders-writing.in')
-rw-r--r-- | doc/user/builders-writing.in | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/doc/user/builders-writing.in b/doc/user/builders-writing.in index 19c91de..2c5cce2 100644 --- a/doc/user/builders-writing.in +++ b/doc/user/builders-writing.in @@ -900,11 +900,13 @@ This functionality could be invoked as in the following example: <para> The <filename>site_scons</filename> directory gives you a place to - put Python modules you can import into your SConscripts - (site_scons), add-on tools that can integrate into &SCons; - (site_scons/site_tools), and a site_scons/site_init.py file that - gets read before any &SConstruct; or &SConscript;, allowing you to - change &SCons;'s default behavior. + put Python modules you can import into your &SConscript; files + (<filename>site_scons</filename>), + add-on tools that can integrate into &SCons; + (<filename>site_scons/site_tools</filename>), + and a <filename>site_scons/site_init.py</filename> file that + gets read before any &SConstruct; or &SConscript; file, + allowing you to change &SCons;'s default behavior. </para> @@ -914,8 +916,8 @@ This functionality could be invoked as in the following example: for instance) and you'd like to use it in your project, the <filename>site_scons</filename> dir is the simplest place to put it. Tools come in two flavors; either a Python function that operates on - an &Environment; or a Python file containing two functions, exists() - and generate(). + an &Environment; or a Python file containing two functions, + <function>exists()</function> and <function>generate()</function>. </para> @@ -990,7 +992,9 @@ This functionality could be invoked as in the following example: to include in &SConscript;s; just put that module in <filename>site_scons/my_utils.py</filename> or any valid Python module name of your choice. For instance you can do something like this in - <filename>site_scons/my_utils.py</filename> to add build_id and MakeWorkDir functions: + <filename>site_scons/my_utils.py</filename> to add + <function>build_id</function> and <function>MakeWorkDir</function> + functions: </para> <scons_example name="site2"> |