b12f/nixpkgs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

doc/hooks/zig.section.md: rewrite

Browse source 
- Normalize header IDs, in order to not cause conflicts with identically named
  headers in other docs.
- Reorganize the hierarchy of information.
This commit is contained in:
Anderson Torres 2023-09-10 08:58:38 -03:00
parent a0b25e2566
commit eea12fdf8c
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/hooks/zig.section.md
View file

@ -4,7 +4,7 @@
In Nixpkgs, `zig.hook` overrides the default build, check and install phases. 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 ```nix
{ lib { lib
@ -27,25 +27,25 @@ stdenv.mkDerivation {
} }
``` ```
## Variables controlling zig.hook {#variables-controlling-zig-hook} ## Variables controlling zig.hook {#zig-hook-variables-controlling}
### `zig.hook` Exclusive Variables {#zigHookExclusiveVariables} ### `zig.hook` Exclusive Variables {#zig-hook-exclusive-variables}
The variables below are exclusive to `zig.hook`. The variables below are exclusive to `zig.hook`.
#### `dontUseZigBuild` {#dontUseZigBuild} #### `dontUseZigBuild` {#dont-use-zig-build}
Disables using `zigBuildPhase`. Disables using `zigBuildPhase`.
#### `dontUseZigCheck` {#dontUseZigCheck} #### `dontUseZigCheck` {#dont-use-zig-check}
Disables using `zigCheckPhase`. Disables using `zigCheckPhase`.
#### `dontUseZigInstall` {#dontUseZigInstall} #### `dontUseZigInstall` {#dont-use-zig-install}
Disables using `zigInstallPhase`. Disables using `zigInstallPhase`.
### Similar variables {#similarVariables} ### Similar variables {#zig-hook-similar-variables}
The following variables are similar to their `stdenv.mkDerivation` counterparts. The following variables are similar to their `stdenv.mkDerivation` counterparts.
@ -55,7 +55,7 @@ The following variables are similar to their `stdenv.mkDerivation` counterparts.
| `zigCheckFlags` | `checkFlags` | | `zigCheckFlags` | `checkFlags` |
| `zigInstallFlags` | `installFlags` | | `zigInstallFlags` | `installFlags` |
### Variables honored by zig.hook {#variables-honored-by-zig-hook} ### Variables honored by zig.hook {#zig-hook-variables-honored}
The following variables commonly used by `stdenv.mkDerivation` are honored by `zig.hook`. The following variables commonly used by `stdenv.mkDerivation` are honored by `zig.hook`.