summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2002-11-22 21:52:31 (GMT)
committerSteven Knight <knight@baldmt.com>2002-11-22 21:52:31 (GMT)
commit8afed5c0a1749053e08465a4c9cf8d05f8fe2340 (patch)
treebd81b6f6fb616f973c42e4ce5944255019b50646 /doc
parent3cd1df2a2faa246a150f9a6e5a29368eab106a30 (diff)
downloadSCons-8afed5c0a1749053e08465a4c9cf8d05f8fe2340.zip
SCons-8afed5c0a1749053e08465a4c9cf8d05f8fe2340.tar.gz
SCons-8afed5c0a1749053e08465a4c9cf8d05f8fe2340.tar.bz2
Document the fact that Builder calls return Node objects.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.122
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 25b046c..895742c 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -867,6 +867,28 @@ or generate a shared library with a nonstandard suffix:
env.SharedLibrary('word', 'word.cpp', SHLIBSUFFIX='.ocx')
.EE
+All builders return an object
+representing the target that will be created.
+This object may be used as a source for
+another build,
+or in any other context in
+which a file name would otherwise be specified.
+For example, if it were necessary
+to add a specific
+.B -D
+flag when compiling one specific object file:
+
+.ES
+bar_obj = env.StaticObject('bar.c', CCFLAGS='-DBAR')
+env.Program(source = ['foo.c', bar_obj, 'main.c'])
+.EE
+
+Using an object in this way
+makes for a more portable build
+by avoiding having to specify
+a platform-specific object suffix
+when calling the Program() builder.
+
.B scons
provides the following builders: