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

Document CMD_STDOUT variable for Command builder - close #134

Browse Source
This commit is contained in:
Josh Holtrop 2021-11-15 21:52:11 -05:00
parent 0face546e3
commit 80d52f25b8
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/user_guide.md
View File

@ -612,14 +612,26 @@ There are several default builders that are built-in to Rscons:
```ruby
env.Command(target, sources, "CMD" => command)
# Example
env.Command("docs.html", "docs.md",
env.Command("user_guide.html", "user_guide.md",
"CMD" => ["pandoc", "-fmarkdown", "-thtml", "-o${_TARGET}", "${_SOURCES}"],
"CMD_DESC" => "PANDOC")
"CMD_DESC" => "Generating user guide:")
```
The `Command` builder executes a user-defined command in order to produce the
desired target file based on the provided source files.
The `Command` builder supports the following construction variables:
* `CMD` (required) specifies the command to execute (an array of strings).
`CMD` is expanded for variable references, so the tokens `${_TARGET}` and
`${_SOURCES}` can be used, for example.
* `CMD_DESC` (optional) specifies the short text description to print when
the builder executes. The given description is followed by the target file
name.
* `CMD_STDOUT` (optional) specifies a file to redirect standard output to.
`CMD_STDOUT` is expanded for variable references, so the token `${_TARGET}`
can be used, for example.
####> The CFile Builder
```ruby