blob: e831b70e55ce78705e4c20405bae1cbda4f083c9 (
plain)
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
60
61
62
63
64
65
66
67
68
69
70
|
# Zig {#zig}
[Zig](https://ziglang.org/) is a general-purpose programming language and toolchain for maintaining robust, optimal and reusable software.
In Nixpkgs, `zig` overrides the default build, check and install phases.
## Example code snippet {#zig-example-code-snippet}
```nix
{
lib,
stdenv,
zig,
}:
stdenv.mkDerivation {
# . . .
nativeBuildInputs = [ zig ];
zigBuildFlags = [ "-Dman-pages=true" ];
dontUseZigCheck = true;
# . . .
}
```
## Variables controlling zig {#zig-variables-controlling}
### `zig` Exclusive Variables {#zig-exclusive-variables}
The variables below are exclusive to `zig`.
#### `dontUseZigConfigure` {#dont-use-zig-configure}
Disables using `zigConfigurePhase`.
#### `dontUseZigBuild` {#dont-use-zig-build}
Disables using `zigBuildPhase`.
#### `dontUseZigCheck` {#dont-use-zig-check}
Disables using `zigCheckPhase`.
#### `dontUseZigInstall` {#dont-use-zig-install}
Disables using `zigInstallPhase`.
#### `dontSetZigDefaultFlags` {#dont-set-zig-default-flags}
Disables using a set of default flags when performing zig builds.
### Similar variables {#zig-similar-variables}
The following variables are similar to their `stdenv.mkDerivation` counterparts.
| `zig` Variable | `stdenv.mkDerivation` Counterpart |
|---------------------|-----------------------------------|
| `zigBuildFlags` | `buildFlags` |
| `zigCheckFlags` | `checkFlags` |
| `zigInstallFlags` | `installFlags` |
### Variables honored by zig {#zig-variables-honored}
The following variables commonly used by `stdenv.mkDerivation` are honored by `zig`.
- `prefixKey`
- `dontAddPrefix`
|