nixpkgs/doc/hooks/meson.section.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

84 lines
2.8 KiB
Markdown
Raw Normal View History

# Meson {#meson}
2023-10-27 20:46:01 +00:00
[Meson](https://mesonbuild.com/) is an open source meta build system meant to be
fast and user-friendly.
2023-10-27 20:46:01 +00:00
In Nixpkgs, meson comes with a setup hook that overrides the configure, check,
and install phases.
2023-10-27 20:46:01 +00:00
Being a meta build system, meson needs an accompanying backend. In the context
of Nixpkgs, the typical companion backend is [Ninja](#ninja), that provides a
setup hook registering ninja-based build and install phases.
2023-10-27 20:46:01 +00:00
## Variables controlling Meson {#meson-variables-controlling}
2023-10-27 20:46:01 +00:00
### Meson Exclusive Variables {#meson-exclusive-variables}
2023-10-27 20:46:01 +00:00
#### `mesonFlags` {#meson-flags}
2023-10-27 20:46:01 +00:00
Controls the flags passed to `meson setup` during configure phase.
2023-10-27 20:46:01 +00:00
#### `mesonWrapMode` {#meson-wrap-mode}
2023-10-27 20:46:01 +00:00
Which value is passed as
[`-Dwrap_mode=`](https://mesonbuild.com/Builtin-options.html#core-options)
to. In Nixpkgs the default value is `nodownload`, so that no subproject will be
downloaded (since network access is already disabled during deployment in
Nixpkgs).
2023-10-27 20:46:01 +00:00
Note: Meson allows pre-population of subprojects that would otherwise be
downloaded.
2023-10-27 20:46:01 +00:00
#### `mesonBuildType` {#meson-build-type}
2023-10-27 14:59:43 +00:00
2023-10-27 20:46:01 +00:00
Which value is passed as
[`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to
`meson setup` during configure phase. In Nixpkgs the default value is `plain`.
2023-10-27 14:59:43 +00:00
2023-10-27 20:46:01 +00:00
#### `mesonAutoFeatures` {#meson-auto-features}
2023-10-27 20:46:01 +00:00
Which value is passed as
[`-Dauto_features=`](https://mesonbuild.com/Builtin-options.html#core-options)
to `meson setup` during configure phase. In Nixpkgs the default value is
`enabled`, meaning that every feature declared as "auto" by the meson scripts
will be enabled.
2023-10-27 20:46:01 +00:00
#### `mesonCheckFlags` {#meson-check-flags}
2023-10-27 20:46:01 +00:00
Controls the flags passed to `meson test` during check phase.
2023-10-27 20:46:01 +00:00
#### `mesonInstallFlags` {#meson-install-flags}
2023-10-27 20:46:01 +00:00
Controls the flags passed to `meson install` during install phase.
2023-10-27 20:46:01 +00:00
#### `mesonInstallTags` {#meson-install-tags}
2023-10-27 20:46:01 +00:00
A list of installation tags passed to Meson's commandline option
[`--tags`](https://mesonbuild.com/Installing.html#installation-tags) during
install phase.
2023-10-27 20:46:01 +00:00
Note: `mesonInstallTags` should be a list of strings, that will be converted to
a comma-separated string that is recognized to `--tags`.
Example: `mesonInstallTags = [ "emulator" "assembler" ];` will be converted to
`--tags emulator,assembler`.
2023-10-27 20:46:01 +00:00
#### `dontUseMesonConfigure` {#dont-use-meson-configure}
2023-10-27 20:46:01 +00:00
When set to true, don't use the predefined `mesonConfigurePhase`.
2023-10-27 20:46:01 +00:00
#### `dontUseMesonCheck` {#dont-use-meson-check}
When set to true, don't use the predefined `mesonCheckPhase`.
#### `dontUseMesonInstall` {#dont-use-meson-install}
When set to true, don't use the predefined `mesonInstallPhase`.
### Honored variables {#meson-honored-variables}
The following variables commonly used by `stdenv.mkDerivation` are honored by
Meson setup hook.
- `prefixKey`
- `enableParallelBuilding`