tjh.dev
nixpkgs mirror (for testing)
github.com/NixOS/nixpkgs
nix
1# Zig {#zig}
2
3[Zig](https://ziglang.org/) is a general-purpose programming language and toolchain for maintaining robust, optimal and reusable software.
4
5In Nixpkgs, `zig` overrides the default build, check and install phases.
6
7## Example code snippet {#zig-example-code-snippet}
8
9```nix
10{
11 lib,
12 stdenv,
13 zig,
14}:
15
16stdenv.mkDerivation {
17 # . . .
18
19 nativeBuildInputs = [ zig ];
20
21 zigBuildFlags = [ "-Dman-pages=true" ];
22
23 dontUseZigCheck = true;
24
25 # . . .
26}
27```
28
29## Variables controlling zig {#zig-variables-controlling}
30
31### `zig` Exclusive Variables {#zig-exclusive-variables}
32
33The variables below are exclusive to `zig`.
34
35#### `dontUseZigConfigure` {#dont-use-zig-configure}
36
37Disables using `zigConfigurePhase`.
38
39#### `dontUseZigBuild` {#dont-use-zig-build}
40
41Disables using `zigBuildPhase`.
42
43#### `dontUseZigCheck` {#dont-use-zig-check}
44
45Disables using `zigCheckPhase`.
46
47#### `dontUseZigInstall` {#dont-use-zig-install}
48
49Disables using `zigInstallPhase`.
50
51#### `dontSetZigDefaultFlags` {#dont-set-zig-default-flags}
52
53Disables using a set of default flags when performing zig builds.
54
55### Similar variables {#zig-similar-variables}
56
57The following variables are similar to their `stdenv.mkDerivation` counterparts.
58
59| `zig` Variable | `stdenv.mkDerivation` Counterpart |
60|---------------------|-----------------------------------|
61| `zigBuildFlags` | `buildFlags` |
62| `zigCheckFlags` | `checkFlags` |
63| `zigInstallFlags` | `installFlags` |
64
65### Variables honored by zig {#zig-variables-honored}
66
67The following variables commonly used by `stdenv.mkDerivation` are honored by `zig`.
68
69- `prefixKey`
70- `dontAddPrefix`