doc/hooks/index.md: add zig.section.md
A somewhat short documentation about zigHook.
This commit is contained in:
parent
9d9af3d49f
commit
130d2fa5e5
2 changed files with 60 additions and 0 deletions
|
@ -29,5 +29,6 @@ tetex-tex-live.section.md
|
||||||
unzip.section.md
|
unzip.section.md
|
||||||
validatePkgConfig.section.md
|
validatePkgConfig.section.md
|
||||||
waf.section.md
|
waf.section.md
|
||||||
|
zig.section.md
|
||||||
xcbuild.section.md
|
xcbuild.section.md
|
||||||
```
|
```
|
||||||
|
|
59
doc/hooks/zig.section.md
Normal file
59
doc/hooks/zig.section.md
Normal file
|
@ -0,0 +1,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`
|
Loading…
Reference in a new issue