josh/rscons
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update README.md notes about build hooks

Browse Source
This commit is contained in:
Josh Holtrop 2014-09-19 12:41:54 -04:00
parent 453295a49b
commit 6d4f27602e
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -173,6 +173,9 @@ Each build hook block will be invoked for every build operation, so the block
should test the target or sources if its action should only apply to some should test the target or sources if its action should only apply to some
subset of build targets or source files. subset of build targets or source files.
Build hooks can alter construction variable values for a particular build
operation. Build hooks can also register new build targets.
The `build_op` parameter to the build hook block is a Hash describing the The `build_op` parameter to the build hook block is a Hash describing the
build operation with the following keys: build operation with the following keys:
* `:builder` - `Builder` instance in use * `:builder` - `Builder` instance in use
@ -317,6 +320,19 @@ cloned_env["CPPPATH"] << "three"
`base_env["CPPPATH"]` will not include "three". `base_env["CPPPATH"]` will not include "three".
#### Build Hooks
Environments can have build hooks which are added with `env.add_build_hook()`.
Build hooks are invoked immediately before a builder executes.
Build hooks can modify the construction variables in use for the build
operation.
They can also register new build targets.
Environments can also have post-build hooks added with `env.add_post_build_hook()`.
Post-build hooks are only invoked if the build operation was a success.
Post-build hooks can invoke commands using the newly-built files, or register
new build targets.
### Construction Variable Naming ### Construction Variable Naming
* uppercase strings - the default construction variables that Rscons uses * uppercase strings - the default construction variables that Rscons uses