diff options
author | Anderson Torres <torres.anderson.85@protonmail.com> | 2023-09-11 23:25:38 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-11 23:25:38 +0000 |
commit | 3fc613c5baa5b1cd5a28c671b98d421d4421b0af (patch) | |
tree | 3728b6194eb2c523ccf02e3b74d7fc7aac1dc9f2 /doc | |
parent | e270be8f44a36a24be946107479c8b2f1bfcc082 (diff) | |
parent | d0a5c478f18a80583f5a197740266bc21b0233e3 (diff) | |
download | nixlib-3fc613c5baa5b1cd5a28c671b98d421d4421b0af.tar nixlib-3fc613c5baa5b1cd5a28c671b98d421d4421b0af.tar.gz nixlib-3fc613c5baa5b1cd5a28c671b98d421d4421b0af.tar.bz2 nixlib-3fc613c5baa5b1cd5a28c671b98d421d4421b0af.tar.lz nixlib-3fc613c5baa5b1cd5a28c671b98d421d4421b0af.tar.xz nixlib-3fc613c5baa5b1cd5a28c671b98d421d4421b0af.tar.zst nixlib-3fc613c5baa5b1cd5a28c671b98d421d4421b0af.zip |
Merge branch 'master' into staging-next
Diffstat (limited to 'doc')
-rw-r--r-- | doc/hooks/waf.section.md | 22 | ||||
-rw-r--r-- | doc/hooks/zig.section.md | 16 |
2 files changed, 19 insertions, 19 deletions
diff --git a/doc/hooks/waf.section.md b/doc/hooks/waf.section.md index a7ebaeb13a50..fa027d87a94d 100644 --- a/doc/hooks/waf.section.md +++ b/doc/hooks/waf.section.md @@ -1,42 +1,42 @@ -# wafHook {#wafHook} +# wafHook {#waf-hook} [Waf](https://waf.io) is a Python-based software building system. In Nixpkgs, `wafHook` overrides the default configure, build, and install phases. -## Variables controlling wafHook {#variablesControllingWafHook} +## Variables controlling wafHook {#waf-hook-variables-controlling} -### `wafHook` Exclusive Variables {#wafHookExclusiveVariables} +### `wafHook` Exclusive Variables {#waf-hook-exclusive-variables} The variables below are exclusive of `wafHook`. -#### `wafPath` {#wafPath} +#### `wafPath` {#waf-path} Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees. 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. 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`. -### Similar variables {#similarVariables} +### Similar variables {#waf-hook-similar-variables} The following variables are similar to their `stdenv.mkDerivation` counterparts. @@ -49,7 +49,7 @@ The following variables are similar to their `stdenv.mkDerivation` counterparts. | `wafInstallFlags` | `installFlags` | | `wafInstallTargets` | `installTargets` | -### Honored variables {#honoredVariables} +### Honored variables {#waf-hook-honored-variables} The following variables commonly used by `stdenv.mkDerivation` are honored by `wafHook`. diff --git a/doc/hooks/zig.section.md b/doc/hooks/zig.section.md index 8178866f44c9..1a09491649d7 100644 --- a/doc/hooks/zig.section.md +++ b/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,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`. -#### `dontUseZigBuild` {#dontUseZigBuild} +#### `dontUseZigBuild` {#dont-use-zig-build} Disables using `zigBuildPhase`. -#### `dontUseZigCheck` {#dontUseZigCheck} +#### `dontUseZigCheck` {#dont-use-zig-check} Disables using `zigCheckPhase`. -#### `dontUseZigInstall` {#dontUseZigInstall} +#### `dontUseZigInstall` {#dont-use-zig-install} Disables using `zigInstallPhase`. -### Similar variables {#similarVariables} +### Similar variables {#zig-hook-similar-variables} 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` | | `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`. |