From 6aadc91de533ceb33a474238fef8a6bd339066d8 Mon Sep 17 00:00:00 2001 From: Mathew Robinson Date: Tue, 6 Aug 2019 10:28:38 -0400 Subject: [ci skip] Clarify docs about writing your own Builder and link to Action Objects man page --- doc/user/builders-writing.xml | 21 +++++++++++---------- 1 file 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): 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): - The builder function must - return a 0 or None 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 0 or None + 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. -- cgit v0.12