Merge pull request #254388 from atorres1985-contrib/fixup-docs

# waf.hook {#wafhook}

# wafHook {#waf-hook}

[Waf](https://waf.io) is a Python-based software building system.

In Nixpkgs, `waf.hook` overrides the default configure, build, and install phases.

In Nixpkgs, `wafHook` overrides the default configure, build, and install phases.

## Variables controlling waf.hook {#variablesControllingWafHook}

## Variables controlling wafHook {#waf-hook-variables-controlling}

### `wafPath` {#wafPath}

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

Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees.

The variables below are exclusive of `wafHook`.

If `wafPath` doesn't exist, then `waf.hook` will copy the `waf` provided from Nixpkgs to it.

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

### `wafConfigureFlags` {#wafConfigureFlags}

Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees.

Controls the flags passed to waf tool during configure phase.

If `wafPath` doesn't exist, then `wafHook` will copy the `waf` provided from Nixpkgs to it.

### `wafFlags` {#wafFlags}

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

Controls the flags passed to waf tool during build and install phases.

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` {#dontAddWafCrossFlags}

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

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

### `dontUseWafConfigure` {#dontUseWafConfigure}

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

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

### `dontUseWafBuild` {#dontUseWafBuild}

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

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

### `dontUseWafInstall` {#dontUseWafInstall}

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

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

### Variables honored by waf.hook {#variablesHonoredByWafHook}

### 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 also honored by `waf.hook`.

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

- `prefixKey`

- `configureTargets`

- `enableParallelBuilding`

- `enableParallelInstalling`

- `buildFlags`

- `buildTargets`

- `installFlags`

- `installTargets`

In Nixpkgs, `zig.hook` overrides the default build, check and install phases.

## Example code snippet {#example-code-snippet}

## Example code snippet {#zig-hook-example-code-snippet}

```nix

{ lib

}

```

## Variables controlling zig.hook {#variables-controlling-zig-hook}

## Variables controlling zig.hook {#zig-hook-variables-controlling}

### `zig.hook` Exclusive Variables {#zigHookExclusiveVariables}

### `zig.hook` Exclusive Variables {#zig-hook-exclusive-variables}

The variables below are exclusive to `zig.hook`.

#### `dontUseZigBuild` {#dontUseZigBuild}

#### `dontUseZigBuild` {#dont-use-zig-build}

Disables using `zigBuildPhase`.

#### `dontUseZigCheck` {#dontUseZigCheck}

#### `dontUseZigCheck` {#dont-use-zig-check}

Disables using `zigCheckPhase`.

#### `dontUseZigInstall` {#dontUseZigInstall}

#### `dontUseZigInstall` {#dont-use-zig-install}

Disables using `zigInstallPhase`.

### Similar variables {#similarVariables}

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

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

| `zigCheckFlags`     | `checkFlags`                      |

| `zigInstallFlags`   | `installFlags`                    |

### Variables honored by zig.hook {#variables-honored-by-zig-hook}

### Variables honored by zig.hook {#zig-hook-variables-honored}

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