diff options
author | Steven Knight <knight@baldmt.com> | 2003-02-02 18:35:15 (GMT) |
---|---|---|
committer | Steven Knight <knight@baldmt.com> | 2003-02-02 18:35:15 (GMT) |
commit | c7dcf9e7a31681c4a0d7043f2c4406be4e7648e9 (patch) | |
tree | 68854e66d53bf8f0bd4b3e95a842033c2d336fd2 /doc/man/scons.1 | |
parent | 8c857d116b57450227a1fe4bc822d8b2e5047f54 (diff) | |
download | SCons-c7dcf9e7a31681c4a0d7043f2c4406be4e7648e9.zip SCons-c7dcf9e7a31681c4a0d7043f2c4406be4e7648e9.tar.gz SCons-c7dcf9e7a31681c4a0d7043f2c4406be4e7648e9.tar.bz2 |
Add a strfunction() to Command actions, and add an env argument to the FunctionAction.strfunction().
Diffstat (limited to 'doc/man/scons.1')
-rw-r--r-- | doc/man/scons.1 | 27 |
1 files changed, 20 insertions, 7 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1 index b196fac..a1eac4c 100644 --- a/doc/man/scons.1 +++ b/doc/man/scons.1 @@ -2993,7 +2993,7 @@ The Python function takes three keyword arguments, .B source (a Node object representing the source file) and -.BR env +.B env (the construction environment used for building the target file). The @@ -3029,17 +3029,30 @@ a = Action(build_it) The second, optional argument is a Python function that returns -a string to be printed describing the action being executed. -This function takes two arguments, -an array of targets to be created by the function action, -and an array of sources used to create the target(s): +a string to be printed to describe the action being executed. +Like the function to build a file, +this function takes three arguments: +.B target +(a Node object representing the target file), +.B source +(a Node object representing the source file) +and +.BR env +(a construction environment). +The +.B target +and +.B source +arguments may be lists of Node objects if there is +more than one target file or source file. +Examples: .ES def build_it(target, source, env): # build the target from the source return 0 -def string_it(target, source): +def string_it(target, source, env): return "building '%s' from '%s'" % (target[0], source[0]) # Use a positional argument. @@ -3056,7 +3069,7 @@ in the signature of the Action when deciding whether a target should be rebuilt because the action changed. This is necessary whenever you want a target to -be rebuilt by an action when a specific +be rebuilt when a specific construction variable changes, because the underlying Python code for a function will not change when the value of the construction variable does. |