diff options
Diffstat (limited to 'doc/hooks/zig.section.md')
| -rw-r--r-- | doc/hooks/zig.section.md | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/doc/hooks/zig.section.md b/doc/hooks/zig.section.md index 483fd285f416e..1a09491649d7f 100644 --- a/doc/hooks/zig.section.md +++ b/doc/hooks/zig.section.md @@ -4,7 +4,7 @@ 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 @@ -27,33 +27,37 @@ stdenv.mkDerivation { } ``` -## Variables controlling zig.hook {#variables-controlling-zig-hook} +## Variables controlling zig.hook {#zig-hook-variables-controlling} -### `dontUseZigBuild` {#dontUseZigBuild} +### `zig.hook` Exclusive Variables {#zig-hook-exclusive-variables} -Disables using `zigBuildPhase`. +The variables below are exclusive to `zig.hook`. -### `zigBuildFlags` {#zigBuildFlags} +#### `dontUseZigBuild` {#dont-use-zig-build} -Controls the flags passed to the build phase. +Disables using `zigBuildPhase`. -### `dontUseZigCheck` {#dontUseZigCheck} +#### `dontUseZigCheck` {#dont-use-zig-check} Disables using `zigCheckPhase`. -### `zigCheckFlags` {#zigCheckFlags} +#### `dontUseZigInstall` {#dont-use-zig-install} -Controls the flags passed to the check phase. +Disables using `zigInstallPhase`. -### `dontUseZigInstall` {#dontUseZigInstall} +### Similar variables {#zig-hook-similar-variables} -Disables using `zigInstallPhase`. +The following variables are similar to their `stdenv.mkDerivation` counterparts. -### `zigInstallFlags` {#zigInstallFlags} +| `zig.hook` Variable | `stdenv.mkDerivation` Counterpart | +|---------------------|-----------------------------------| +| `zigBuildFlags` | `buildFlags` | +| `zigCheckFlags` | `checkFlags` | +| `zigInstallFlags` | `installFlags` | -Controls the flags passed to the install phase. +### Variables honored by zig.hook {#zig-hook-variables-honored} -### Variables honored by zig.hook {#variables-honored-by-zig-hook} +The following variables commonly used by `stdenv.mkDerivation` are honored by `zig.hook`. - `prefixKey` - `dontAddPrefix` |