diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/builders/packages/ibus.section.md | 4 | ||||
-rw-r--r-- | doc/hooks/waf.section.md | 50 | ||||
-rw-r--r-- | doc/hooks/zig.section.md | 32 |
3 files changed, 49 insertions, 37 deletions
diff --git a/doc/builders/packages/ibus.section.md b/doc/builders/packages/ibus.section.md index 4eb74c0b6912a..817e55d56f1f9 100644 --- a/doc/builders/packages/ibus.section.md +++ b/doc/builders/packages/ibus.section.md @@ -29,12 +29,12 @@ _Note: each language passed to `langs` must be an attribute name in `pkgs.hunspe ## Built-in emoji picker {#sec-ibus-typing-booster-emoji-picker} -The `ibus-engines.typing-booster` package contains a program named `emoji-picker`. To display all emojis correctly, a special font such as `noto-fonts-emoji` is needed: +The `ibus-engines.typing-booster` package contains a program named `emoji-picker`. To display all emojis correctly, a special font such as `noto-fonts-color-emoji` is needed: On NixOS, it can be installed using the following expression: ```nix { pkgs, ... }: { - fonts.packages = with pkgs; [ noto-fonts-emoji ]; + fonts.packages = with pkgs; [ noto-fonts-color-emoji ]; } ``` diff --git a/doc/hooks/waf.section.md b/doc/hooks/waf.section.md index 8dc78121cd9d1..fa027d87a94d7 100644 --- a/doc/hooks/waf.section.md +++ b/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/doc/hooks/zig.section.md b/doc/hooks/zig.section.md index 483fd285f416e..1a09491649d7f 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,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` |