summaryrefslogtreecommitdiff
path: root/doc/user/builders-writing.xml
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2019-10-07 17:51:00 +0200
committerJörg Frings-Fürst <debian@jff-webhosting.net>2019-10-07 17:51:00 +0200
commitac95e6b0e59367452b30f194e9a937a44938ded5 (patch)
tree446c6a1ae777002d536d62d87290ec91b6fae337 /doc/user/builders-writing.xml
parentd2798622a34a90a7e921148d1d0bf5d9084c1319 (diff)
parent957d7c1366611f7239a9de1e985056ef52146914 (diff)
Merge branch 'feature/upstream' into develop
Diffstat (limited to 'doc/user/builders-writing.xml')
-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 c36d468..2fcb11b 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>