summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMathew Robinson <chasinglogic@gmail.com>2019-08-06 14:28:38 (GMT)
committerMathew Robinson <chasinglogic@gmail.com>2019-08-06 16:39:36 (GMT)
commit6aadc91de533ceb33a474238fef8a6bd339066d8 (patch)
treeaadf63f0f2938dea8c63be05535ef0830f4648ea /doc
parentd6401f4751792eef1ec0909dac10cd4548ad92a9 (diff)
downloadSCons-6aadc91de533ceb33a474238fef8a6bd339066d8.zip
SCons-6aadc91de533ceb33a474238fef8a6bd339066d8.tar.gz
SCons-6aadc91de533ceb33a474238fef8a6bd339066d8.tar.bz2
[ci skip] Clarify docs about writing your own Builder and link to Action Objects man page
Diffstat (limited to 'doc')
-rw-r--r--doc/user/builders-writing.xml21
1 files changed, 11 insertions, 10 deletions
diff --git a/doc/user/builders-writing.xml b/doc/user/builders-writing.xml
index ce95128..e20e99b 100644
--- a/doc/user/builders-writing.xml
+++ b/doc/user/builders-writing.xml
@@ -453,7 +453,7 @@ def build_function(target, source, env):
A list of Node objects representing
the target or targets to be
- built by this builder function.
+ built by this function.
The file names of these target(s)
may be extracted using the Python &str; function.
@@ -469,7 +469,7 @@ def build_function(target, source, env):
A list of Node objects representing
the sources to be
- used by this builder function to build the targets.
+ used by this function to build the targets.
The file names of these source(s)
may be extracted using the Python &str; function.
@@ -484,7 +484,7 @@ def build_function(target, source, env):
<para>
The &consenv; used for building the target(s).
- The builder function may use any of the
+ The function may use any of the
environment's construction variables
in any way to affect how it builds the targets.
@@ -496,13 +496,14 @@ def build_function(target, source, env):
<para>
- The builder function must
- return a <literal>0</literal> or <literal>None</literal> value
- if the target(s) are built successfully.
- The builder function
- may raise an exception
- or return any non-zero value
- to indicate that the build is unsuccessful.
+ The function will be constructed as a SCons FunctionAction and
+ must return a <literal>0</literal> or <literal>None</literal>
+ value if the target(s) are built successfully. The function may
+ raise an exception or return any non-zero value to indicate that
+ the build is unsuccessful.
+
+ For more information on Actions see the Action Objects section of
+ the man page.
</para>