wafHook: documentation
A very comprehensive one!
This commit is contained in:
parent
8ad7ef7624
commit
b5549d90f2
1 changed files with 48 additions and 1 deletions
|
@ -1,3 +1,50 @@
|
|||
# wafHook {#wafhook}
|
||||
|
||||
Overrides the configure, build, and install phases. This will run the “waf” script used by many projects. If `wafPath` (default `./waf`) doesn’t exist, it will copy the version of waf available in Nixpkgs. `wafFlags` can be used to pass flags to the waf script.
|
||||
[Waf](https://waf.io) is a Python-based software building system.
|
||||
|
||||
In Nixpkgs, `wafHook` overrides the default configure, build, and install phases.
|
||||
|
||||
## Variables controlling wafHook
|
||||
|
||||
### `wafPath` {#wafPath}
|
||||
|
||||
Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees.
|
||||
|
||||
If `wafPath` doesn't exist, then `wafHook` will copy the `waf` provided from Nixpkgs to it.
|
||||
|
||||
### `wafConfigureFlags` {#wafConfigureFlags}
|
||||
|
||||
Controls the flags passed to waf tool during configure phase.
|
||||
|
||||
### `wafFlags` {#wafFlags}
|
||||
|
||||
Controls the flags passed to waf tool during build and install phases.
|
||||
|
||||
### `dontAddWafCrossFlags` {#dontAddWafCrossFlags}
|
||||
|
||||
When set to `true`, don't add cross compilation flags during configure phase.
|
||||
|
||||
### `dontUseWafConfigure` {#dontUseWafConfigure}
|
||||
|
||||
When set to true, don't use the predefined `wafConfigurePhase`.
|
||||
|
||||
### `dontUseWafBuild` {#dontUseWafBuild}
|
||||
|
||||
When set to true, don't use the predefined `wafBuildPhase`.
|
||||
|
||||
### `dontUseWafInstall` {#dontUseWafInstall}
|
||||
|
||||
When set to true, don't use the predefined `wafInstallPhase`.
|
||||
|
||||
### Variables honored by wafHook {#variablesHonoredByWafHook}
|
||||
|
||||
The following variables commonly used by `stdenv.mkDerivation` are also honored by `wafHook`.
|
||||
|
||||
- `prefixKey`
|
||||
- `configureTargets`
|
||||
- `enableParallelBuilding`
|
||||
- `enableParallelInstalling`
|
||||
- `buildFlags`
|
||||
- `buildTargets`
|
||||
- `installFlags`
|
||||
- `installTargets`
|
||||
|
|
Loading…
Reference in a new issue