summaryrefslogtreecommitdiff
path: root/doc/user/tasks.in
diff options
context:
space:
mode:
authorLuca Falavigna <dktrkranz@debian.org>2011-02-10 23:18:11 +0100
committerLuca Falavigna <dktrkranz@debian.org>2011-02-10 23:18:11 +0100
commit5993fb09d54d47cc362d979a9cc44ea6dce65b2a (patch)
treefae6dc27e661b0b5542ea7efa9fb4e7efe5fa47b /doc/user/tasks.in
parentb5754794e1f526800cc5386de55238c23a539ff4 (diff)
parent84c6f9729dbbc175431874957d0654310410bd6f (diff)
Merge commit 'upstream/2.0.1'
Diffstat (limited to 'doc/user/tasks.in')
-rw-r--r--doc/user/tasks.in67
1 files changed, 66 insertions, 1 deletions
diff --git a/doc/user/tasks.in b/doc/user/tasks.in
index 2945d1c..8842dcd 100644
--- a/doc/user/tasks.in
+++ b/doc/user/tasks.in
@@ -29,7 +29,7 @@ on as they become more complex. Most build tools have special
purpose constructs for performing these tasks, but since &SConscript;
files are &Python; scripts, you can use more flexible built-in &Python;
services to perform these tasks. This appendix lists a number of these
-tasks and how to implement them in &Python;.
+tasks and how to implement them in &Python; and &SCons;.
</para>
<example>
@@ -79,3 +79,68 @@ output</title>
output = os.popen(command).read()
</programlisting>
</example>
+
+<example>
+<title>Generating source code: how code can be generated and used by SCons</title>
+
+<para>
+
+The Copy builders here could be any arbitrary shell or python function
+that produces one or more files. This example shows how to create
+those files and use them in &SCons;.
+
+</para>
+
+<scons_example name="ex1">
+<file name="SConstruct" printme="1">
+#### SConstruct
+env = Environment()
+env.Append(CPPPATH = "#")
+
+## Header example
+env.Append(BUILDERS =
+ {'Copy1' : Builder(action = 'cat < $SOURCE > $TARGET',
+ suffix='.h', src_suffix='.bar')})
+env.Copy1('test.bar') # produces test.h from test.bar.
+env.Program('app','main.cpp') # indirectly depends on test.bar
+
+## Source file example
+env.Append(BUILDERS =
+ {'Copy2' : Builder(action = 'cat < $SOURCE > $TARGET',
+ suffix='.cpp', src_suffix='.bar2')})
+foo = env.Copy2('foo.bar2') # produces foo.cpp from foo.bar2.
+env.Program('app2',['main2.cpp'] + foo) # compiles main2.cpp and foo.cpp into app2.
+</file>
+
+<file name="main.cpp">
+#include "test.h"
+</file>
+<file name="test.bar">
+// nothing here
+</file>
+<file name="main2.cpp">
+//// main2.cpp
+</file>
+<file name="foo.bar2">
+// nothing here
+</file>
+</scons_example>
+
+<para>
+
+Where main.cpp looks like this:
+
+</para>
+
+ <scons_example_file example="ex1" name="main.cpp">
+ </scons_example_file>
+
+<para>
+produces this:
+</para>
+
+ <scons_output example="ex1">
+ <scons_output_command>scons -Q</scons_output_command>
+ </scons_output>
+
+</example>