diff options
author | Doron Behar <doron.behar@gmail.com> | 2023-08-01 16:52:24 +0300 |
---|---|---|
committer | Doron Behar <doron.behar@gmail.com> | 2023-08-01 16:52:24 +0300 |
commit | cc63e791bf65fd988a12805fbc2b65d4a153251f (patch) | |
tree | 6a0e0c51f20721bd542cdf90b84232543210fb47 /doc | |
parent | 9bef3687ff5f07e342cc3394b4438f35f71522c2 (diff) | |
parent | 1015d9a9f890bcc203b1a3fe2ad3aa73495bfe4a (diff) |
Merge branch 'master' into staging-next
* master: (77 commits) containerd: 1.7.2 -> 1.7.3 python310Packages.transformers: 4.30.2 -> 4.31.0 plasma-sdk: unbreak build, again stellarium: add patch for indi 2.0 compatibility indi-full: 1.9.8 -> 2.0.2, reenable Atik, Pentax and SX drivers indilib: 1.9.8 -> 2.0.2 plasma: 5.27.6 -> 5.27.7 alsa-scarlett-gui: light refactoring alsa-scarlett-gui: Change icons path back to relative in desktop entry file alsa-scarlet-gui: light refactoring Done some light refactoring for better consitence in the code. alsa-scarlett-gui: fix for deskop integration alsa-scarlett-gui: fixed desktop entry release-notes: note breaking woodpecker update woodpecker-*: 0.15.11 -> 1.0.0 pnpm-lock-export: use fork with v6 support suricata: 6.0.13 -> 7.0.0 rubyfmt: add support for macos arm64/x86 rubyfmt: init at 0.8.1 dayon: init at 11.0.7 nixos/atuin: harden systemd unit ...
Diffstat (limited to 'doc')
-rw-r--r-- | doc/hooks/index.md | 1 | ||||
-rw-r--r-- | doc/hooks/zig.section.md | 59 |
2 files changed, 60 insertions, 0 deletions
diff --git a/doc/hooks/index.md b/doc/hooks/index.md index c1e86a3033073..602febaf9d9ba 100644 --- a/doc/hooks/index.md +++ b/doc/hooks/index.md @@ -29,5 +29,6 @@ tetex-tex-live.section.md unzip.section.md validatePkgConfig.section.md waf.section.md +zig.section.md xcbuild.section.md ``` diff --git a/doc/hooks/zig.section.md b/doc/hooks/zig.section.md new file mode 100644 index 0000000000000..78b8262f4749d --- /dev/null +++ b/doc/hooks/zig.section.md @@ -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` |