summaryrefslogtreecommitdiff
path: root/doc/user/builders-writing.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/builders-writing.xml')
-rw-r--r--doc/user/builders-writing.xml33
1 files changed, 17 insertions, 16 deletions
diff --git a/doc/user/builders-writing.xml b/doc/user/builders-writing.xml
index c36d468..a408479 100644
--- a/doc/user/builders-writing.xml
+++ b/doc/user/builders-writing.xml
@@ -196,7 +196,7 @@ env.Foo('file.foo', 'file.input')
<file name="file.input">
file.input
</file>
- <file name="foobuild" chmod="0755">
+ <file name="foobuild" chmod="0o755">
cat
</file>
</scons_example>
@@ -309,7 +309,7 @@ file.input
<file name="hello.c">
hello.c
</file>
- <file name="foobuild" chmod="0755">
+ <file name="foobuild" chmod="0o755">
cat
</file>
</scons_example>
@@ -389,7 +389,7 @@ file1.input
<file name="file2.input">
file2.input
</file>
- <file name="foobuild" chmod="0755">
+ <file name="foobuild" chmod="0o755">
cat
</file>
</scons_example>
@@ -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>
@@ -681,7 +682,7 @@ env.Foo('file')
<file name="file.input">
file.input
</file>
- <file name="foobuild" chmod="0755">
+ <file name="foobuild" chmod="0o755">
cat
</file>
</scons_example>
@@ -765,7 +766,7 @@ file.input
<file name="new_source">
new_source
</file>
- <file name="foobuild" chmod="0755">
+ <file name="foobuild" chmod="0o755">
cat
</file>
</scons_example>
@@ -839,7 +840,7 @@ modify1.input
<file name="modify2.in">
modify2.input
</file>
- <file name="my_command" chmod="0755">
+ <file name="my_command" chmod="0o755">
cat
</file>