nixpkgs/doc/hooks/waf.section.md

# wafHook {#waf-hook}

[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 {#waf-hook-variables-controlling}

### `wafHook` Exclusive Variables {#waf-hook-exclusive-variables}

The variables below are exclusive of `wafHook`.

#### `wafPath` {#waf-path}

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.

#### `wafFlags` {#waf-flags}

Controls the flags passed to waf tool during build and install phases. For settings specific to build or install phases, use `wafBuildFlags` or `wafInstallFlags` respectively.

#### `dontAddWafCrossFlags` {#dont-add-waf-cross-flags}

When set to `true`, don't add cross compilation flags during configure phase.

#### `dontUseWafConfigure` {#dont-use-waf-configure}

When set to true, don't use the predefined `wafConfigurePhase`.

#### `dontUseWafBuild` {#dont-use-waf-build}

When set to true, don't use the predefined `wafBuildPhase`.

#### `dontUseWafInstall` {#dont-use-waf-install}

When set to true, don't use the predefined `wafInstallPhase`.

### Similar variables {#waf-hook-similar-variables}

The following variables are similar to their `stdenv.mkDerivation` counterparts.

| `wafHook` Variable    | `stdenv.mkDerivation` Counterpart |
|-----------------------|-----------------------------------|
| `wafConfigureFlags`   | `configureFlags`                  |
| `wafConfigureTargets` | `configureTargets`                |
| `wafBuildFlags`       | `buildFlags`                      |
| `wafBuildTargets`     | `buildTargets`                    |
| `wafInstallFlags`     | `installFlags`                    |
| `wafInstallTargets`   | `installTargets`                  |

### Honored variables {#waf-hook-honored-variables}

The following variables commonly used by `stdenv.mkDerivation` are honored by `wafHook`.

- `prefixKey`
- `enableParallelBuilding`
- `enableParallelInstalling`
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			`# wafHook {#waf-hook}`
doc: Move non-stdenv hooks out of stdenv chapter 2022-10-13 13:36:04 +00:00
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00			`[Waf](https://waf.io) is a Python-based software building system.`

doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			In Nixpkgs, `wafHook` overrides the default configure, build, and install phases.
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			`## Variables controlling wafHook {#waf-hook-variables-controlling}`
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			### `wafHook` Exclusive Variables {#waf-hook-exclusive-variables}
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			The variables below are exclusive of `wafHook`.
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			#### `wafPath` {#waf-path}
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees.
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			If `wafPath` doesn't exist, then `wafHook` will copy the `waf` provided from Nixpkgs to it.
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			#### `wafFlags` {#waf-flags}
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			Controls the flags passed to waf tool during build and install phases. For settings specific to build or install phases, use `wafBuildFlags` or `wafInstallFlags` respectively.
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			#### `dontAddWafCrossFlags` {#dont-add-waf-cross-flags}
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
			When set to `true`, don't add cross compilation flags during configure phase.

doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			#### `dontUseWafConfigure` {#dont-use-waf-configure}
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
			When set to true, don't use the predefined `wafConfigurePhase`.

doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			#### `dontUseWafBuild` {#dont-use-waf-build}
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
			When set to true, don't use the predefined `wafBuildPhase`.

doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			#### `dontUseWafInstall` {#dont-use-waf-install}
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
			When set to true, don't use the predefined `wafInstallPhase`.

doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			`### Similar variables {#waf-hook-similar-variables}`

			The following variables are similar to their `stdenv.mkDerivation` counterparts.

			\| `wafHook` Variable \| `stdenv.mkDerivation` Counterpart \|
			`\|-----------------------\|-----------------------------------\|`
			\| `wafConfigureFlags` \| `configureFlags` \|
			\| `wafConfigureTargets` \| `configureTargets` \|
			\| `wafBuildFlags` \| `buildFlags` \|
			\| `wafBuildTargets` \| `buildTargets` \|
			\| `wafInstallFlags` \| `installFlags` \|
			\| `wafInstallTargets` \| `installTargets` \|

			`### Honored variables {#waf-hook-honored-variables}`
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
doc/hooks/waf.section.md: rewrite - Normalize header IDs, in order to not cause conflicts with identically named headers in other docs. - Reorganize the hierarchy of information. 2023-09-10 11:56:09 +00:00			The following variables commonly used by `stdenv.mkDerivation` are honored by `wafHook`.
wafHook: documentation A very comprehensive one! 2023-07-17 02:24:31 +00:00
			- `prefixKey`
			- `enableParallelBuilding`
			- `enableParallelInstalling`