doc/hooks/meson.section.md

   1 # Meson {#meson}
   2
   3 [Meson](https://mesonbuild.com/) is an open source meta build system meant to be
   4 fast and user-friendly.
   5
   6 In Nixpkgs, meson comes with a setup hook that overrides the configure, check,
   7 and install phases.
   8
   9 Being a meta build system, meson needs an accompanying backend. In the context
  10 of Nixpkgs, the typical companion backend is [Ninja](#ninja), that provides a
  11 setup hook registering ninja-based build and install phases.
  12
  13 ## Variables controlling Meson {#meson-variables-controlling}
  14
  15 ### Meson Exclusive Variables {#meson-exclusive-variables}
  16
  17 #### `mesonFlags` {#meson-flags}
  18
  19 Controls the flags passed to `meson setup` during configure phase.
  20
  21 #### `mesonBuildDir` {#meson-build-dir}
  22
  23 Directory where Meson will put intermediate files.
  24
  25 Setting this can be useful for debugging multiple Meson builds while in the same source directory, for example, when building for different platforms.
  26 Different values for each build will prevent build artefacts from interefering with each other.
  27 This setting has no tangible effect when running the build in a sandboxed derivation.
  28
  29 The default value is `build`.
  30
  31 #### `mesonWrapMode` {#meson-wrap-mode}
  32
  33 Which value is passed as
  34 [`-Dwrap_mode=`](https://mesonbuild.com/Builtin-options.html#core-options)
  35 to. In Nixpkgs the default value is `nodownload`, so that no subproject will be
  36 downloaded (since network access is already disabled during deployment in
  37 Nixpkgs).
  38
  39 Note: Meson allows pre-population of subprojects that would otherwise be
  40 downloaded.
  41
  42 #### `mesonBuildType` {#meson-build-type}
  43
  44 Which value is passed as
  45 [`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to
  46 `meson setup` during configure phase. In Nixpkgs the default value is `plain`.
  47
  48 #### `mesonAutoFeatures` {#meson-auto-features}
  49
  50 Which value is passed as
  51 [`-Dauto_features=`](https://mesonbuild.com/Builtin-options.html#core-options)
  52 to `meson setup` during configure phase. In Nixpkgs the default value is
  53 `enabled`, meaning that every feature declared as "auto" by the meson scripts
  54 will be enabled.
  55
  56 #### `mesonCheckFlags` {#meson-check-flags}
  57
  58 Controls the flags passed to `meson test` during check phase.
  59
  60 #### `mesonInstallFlags` {#meson-install-flags}
  61
  62 Controls the flags passed to `meson install` during install phase.
  63
  64 #### `mesonInstallTags` {#meson-install-tags}
  65
  66 A list of installation tags passed to Meson's commandline option
  67 [`--tags`](https://mesonbuild.com/Installing.html#installation-tags) during
  68 install phase.
  69
  70 Note: `mesonInstallTags` should be a list of strings, that will be converted to
  71 a comma-separated string that is recognized to `--tags`.
  72 Example: `mesonInstallTags = [ "emulator" "assembler" ];` will be converted to
  73 `--tags emulator,assembler`.
  74
  75 #### `dontUseMesonConfigure` {#dont-use-meson-configure}
  76
  77 When set to true, don't use the predefined `mesonConfigurePhase`.
  78
  79 #### `dontUseMesonCheck` {#dont-use-meson-check}
  80
  81 When set to true, don't use the predefined `mesonCheckPhase`.
  82
  83 #### `dontUseMesonInstall` {#dont-use-meson-install}
  84
  85 When set to true, don't use the predefined `mesonInstallPhase`.
  86
  87 ### Honored variables {#meson-honored-variables}
  88
  89 The following variables commonly used by `stdenv.mkDerivation` are honored by
  90 Meson setup hook.
  91
  92 - `prefixKey`
  93 - `enableParallelBuilding`