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

user guide: expand Builders section

Browse Source
This commit is contained in:
Josh Holtrop 2019-06-14 15:14:37 -04:00
parent 5b67ad88d3
commit e5c690a4fc
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/user_guide.md
View File

@ -440,10 +440,25 @@ It also instructs the linker to link against the `m` library.
Rscons uses builder objects to produce *target* output files from *source* Rscons uses builder objects to produce *target* output files from *source*
input files. input files.
Each builder is registered by calling a method on the `Environment` object A build target to be built using a builder is registered by calling a method on
that matches the builder's name. the `Environment` object that matches the builder's name.
For example, a `Program` builder is registered by calling the `env.Program` For example, a `Program` build target is registered by calling the
method. `env.Program` method.
The general syntax for registering a build target using a builder is:
```ruby
env.BuilderName(target, sources, vars = {})
```
The `target` parameter is the path to the output file or directory.
The `sources` parameter is the path or paths to the input file(s) to be used
by the builder.
The `vars` parameter is an optional Hash which can include construction
variables to be used for this build target.
Any construction variable values specified in this parameter will override
those assigned to the Environment.
There are several default builders that are built-in to Rscons: There are several default builders that are built-in to Rscons:
* `Command`, which executes a user-defined command to produce the target. * `Command`, which executes a user-defined command to produce the target.