summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorAnderson Torres <torres.anderson.85@protonmail.com>2023-09-07 20:15:21 -0300
committerAnderson Torres <torres.anderson.85@protonmail.com>2023-09-09 15:27:11 +0000
commit1b75ac310a4fba9e8245a23760bd796f103eb851 (patch)
treebd7ccb1b42d637db53568e5da4979e0f3848a23a /doc
parenta49eb940a293f5ff3660d422ce1de00c41518338 (diff)
downloadnixpkgs-1b75ac310a4fba9e8245a23760bd796f103eb851.tar
nixpkgs-1b75ac310a4fba9e8245a23760bd796f103eb851.tar.gz
nixpkgs-1b75ac310a4fba9e8245a23760bd796f103eb851.tar.bz2
nixpkgs-1b75ac310a4fba9e8245a23760bd796f103eb851.tar.lz
nixpkgs-1b75ac310a4fba9e8245a23760bd796f103eb851.tar.xz
nixpkgs-1b75ac310a4fba9e8245a23760bd796f103eb851.tar.zst
nixpkgs-1b75ac310a4fba9e8245a23760bd796f103eb851.zip
doc/hooks/zig.section.md: reword
- Refer to stdenv documentation instead of repeating it
Diffstat (limited to 'doc')
-rw-r--r--doc/hooks/zig.section.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/doc/hooks/zig.section.md b/doc/hooks/zig.section.md
index 483fd285f41..8178866f44c 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`