about summary refs log tree commit diff
path: root/nixpkgs/doc/hooks/zig.section.md
blob: 78b8262f4749dccdad323f7efeace4e170774040 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# zigHook {#zighook}

[Zig](https://ziglang.org/) is a general-purpose programming language and toolchain for maintaining robust, optimal and reusable software.

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

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

```nix
{ lib
, stdenv
, zigHook
}:

stdenv.mkDerivation {
  # . . .

  nativeBuildInputs = [
    zigHook
  ];

  zigBuildFlags = [ "-Dman-pages=true" ];

  dontUseZigCheck = true;

  # . . .
}
```

## Variables controlling zigHook {#variables-controlling-zighook}

### `dontUseZigBuild` {#dontUseZigBuild}

Disables using `zigBuildPhase`.

### `zigBuildFlags` {#zigBuildFlags}

Controls the flags passed to the build phase.

### `dontUseZigCheck` {#dontUseZigCheck}

Disables using `zigCheckPhase`.

### `zigCheckFlags` {#zigCheckFlags}

Controls the flags passed to the check phase.

### `dontUseZigInstall` {#dontUseZigInstall}

Disables using `zigInstallPhase`.

### `zigInstallFlags` {#zigInstallFlags}

Controls the flags passed to the install phase.

### Variables honored by zigHook {#variablesHonoredByZigHook}

- `prefixKey`
- `dontAddPrefix`