diff options
Diffstat (limited to 'doc/hooks')
-rw-r--r-- | doc/hooks/zig.section.md | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/doc/hooks/zig.section.md b/doc/hooks/zig.section.md index 483fd285f416e..8178866f44c9a 100644 --- a/doc/hooks/zig.section.md +++ b/doc/hooks/zig.section.md @@ -29,31 +29,35 @@ stdenv.mkDerivation { ## Variables controlling zig.hook {#variables-controlling-zig-hook} -### `dontUseZigBuild` {#dontUseZigBuild} +### `zig.hook` Exclusive Variables {#zigHookExclusiveVariables} -Disables using `zigBuildPhase`. +The variables below are exclusive to `zig.hook`. -### `zigBuildFlags` {#zigBuildFlags} +#### `dontUseZigBuild` {#dontUseZigBuild} -Controls the flags passed to the build phase. +Disables using `zigBuildPhase`. -### `dontUseZigCheck` {#dontUseZigCheck} +#### `dontUseZigCheck` {#dontUseZigCheck} Disables using `zigCheckPhase`. -### `zigCheckFlags` {#zigCheckFlags} - -Controls the flags passed to the check phase. - -### `dontUseZigInstall` {#dontUseZigInstall} +#### `dontUseZigInstall` {#dontUseZigInstall} Disables using `zigInstallPhase`. -### `zigInstallFlags` {#zigInstallFlags} +### Similar variables {#similarVariables} + +The following variables are similar to their `stdenv.mkDerivation` counterparts. -Controls the flags passed to the install phase. +| `zig.hook` Variable | `stdenv.mkDerivation` Counterpart | +|---------------------|-----------------------------------| +| `zigBuildFlags` | `buildFlags` | +| `zigCheckFlags` | `checkFlags` | +| `zigInstallFlags` | `installFlags` | ### 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` |