about summary refs log tree commit diff
path: root/nixpkgs/doc
diff options
context:
space:
mode:
authorAlyssa Ross <hi@alyssa.is>2023-09-14 13:17:39 +0000
committerAlyssa Ross <hi@alyssa.is>2023-09-14 13:17:39 +0000
commit56e87d10ec12e00eab5c4b5710e01ab50eec267f (patch)
treebaff33c3da97619d02441379b3f0f369da8f3d5a /nixpkgs/doc
parentcc14c6e02d8424c1d446d248f71e08243181af8d (diff)
parent3a2786eea085f040a66ecde1bc3ddc7099f6dbeb (diff)
downloadnixlib-56e87d10ec12e00eab5c4b5710e01ab50eec267f.tar
nixlib-56e87d10ec12e00eab5c4b5710e01ab50eec267f.tar.gz
nixlib-56e87d10ec12e00eab5c4b5710e01ab50eec267f.tar.bz2
nixlib-56e87d10ec12e00eab5c4b5710e01ab50eec267f.tar.lz
nixlib-56e87d10ec12e00eab5c4b5710e01ab50eec267f.tar.xz
nixlib-56e87d10ec12e00eab5c4b5710e01ab50eec267f.tar.zst
nixlib-56e87d10ec12e00eab5c4b5710e01ab50eec267f.zip
Merge branch 'nixos-unstable' of https://github.com/NixOS/nixpkgs
Diffstat (limited to 'nixpkgs/doc')
-rw-r--r--nixpkgs/doc/hooks/waf.section.md50
-rw-r--r--nixpkgs/doc/hooks/zig.section.md32
2 files changed, 47 insertions, 35 deletions
diff --git a/nixpkgs/doc/hooks/waf.section.md b/nixpkgs/doc/hooks/waf.section.md
index 8dc78121cd9d..fa027d87a94d 100644
--- a/nixpkgs/doc/hooks/waf.section.md
+++ b/nixpkgs/doc/hooks/waf.section.md
@@ -1,50 +1,58 @@
-# waf.hook {#wafhook}
+# wafHook {#waf-hook}
 
 [Waf](https://waf.io) is a Python-based software building system.
 
-In Nixpkgs, `waf.hook` overrides the default configure, build, and install phases.
+In Nixpkgs, `wafHook` overrides the default configure, build, and install phases.
 
-## Variables controlling waf.hook {#variablesControllingWafHook}
+## Variables controlling wafHook {#waf-hook-variables-controlling}
 
-### `wafPath` {#wafPath}
+### `wafHook` Exclusive Variables {#waf-hook-exclusive-variables}
 
-Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees.
+The variables below are exclusive of `wafHook`.
 
-If `wafPath` doesn't exist, then `waf.hook` will copy the `waf` provided from Nixpkgs to it.
+#### `wafPath` {#waf-path}
 
-### `wafConfigureFlags` {#wafConfigureFlags}
+Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees.
 
-Controls the flags passed to waf tool during configure phase.
+If `wafPath` doesn't exist, then `wafHook` will copy the `waf` provided from Nixpkgs to it.
 
-### `wafFlags` {#wafFlags}
+#### `wafFlags` {#waf-flags}
 
-Controls the flags passed to waf tool during build and install phases.
+Controls the flags passed to waf tool during build and install phases. For settings specific to build or install phases, use `wafBuildFlags` or `wafInstallFlags` respectively.
 
-### `dontAddWafCrossFlags` {#dontAddWafCrossFlags}
+#### `dontAddWafCrossFlags` {#dont-add-waf-cross-flags}
 
 When set to `true`, don't add cross compilation flags during configure phase.
 
-### `dontUseWafConfigure` {#dontUseWafConfigure}
+#### `dontUseWafConfigure` {#dont-use-waf-configure}
 
 When set to true, don't use the predefined `wafConfigurePhase`.
 
-### `dontUseWafBuild` {#dontUseWafBuild}
+#### `dontUseWafBuild` {#dont-use-waf-build}
 
 When set to true, don't use the predefined `wafBuildPhase`.
 
-### `dontUseWafInstall` {#dontUseWafInstall}
+#### `dontUseWafInstall` {#dont-use-waf-install}
 
 When set to true, don't use the predefined `wafInstallPhase`.
 
-### Variables honored by waf.hook {#variablesHonoredByWafHook}
+### Similar variables {#waf-hook-similar-variables}
+
+The following variables are similar to their `stdenv.mkDerivation` counterparts.
+
+| `wafHook` Variable    | `stdenv.mkDerivation` Counterpart |
+|-----------------------|-----------------------------------|
+| `wafConfigureFlags`   | `configureFlags`                  |
+| `wafConfigureTargets` | `configureTargets`                |
+| `wafBuildFlags`       | `buildFlags`                      |
+| `wafBuildTargets`     | `buildTargets`                    |
+| `wafInstallFlags`     | `installFlags`                    |
+| `wafInstallTargets`   | `installTargets`                  |
+
+### Honored variables {#waf-hook-honored-variables}
 
-The following variables commonly used by `stdenv.mkDerivation` are also honored by `waf.hook`.
+The following variables commonly used by `stdenv.mkDerivation` are honored by `wafHook`.
 
 - `prefixKey`
-- `configureTargets`
 - `enableParallelBuilding`
 - `enableParallelInstalling`
-- `buildFlags`
-- `buildTargets`
-- `installFlags`
-- `installTargets`
diff --git a/nixpkgs/doc/hooks/zig.section.md b/nixpkgs/doc/hooks/zig.section.md
index 483fd285f416..1a09491649d7 100644
--- a/nixpkgs/doc/hooks/zig.section.md
+++ b/nixpkgs/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`