summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorVladimír Čunát <v@cunat.cz>2023-10-26 10:36:50 +0200
committerVladimír Čunát <v@cunat.cz>2023-10-26 10:36:50 +0200
commitd811555465785e76fc06872f4bb14d4dd1dfed8c (patch)
tree91db30ffe3553dcd7c9766c4163687f7b951dd16 /doc
parent7054a80f3b8061bd532e407f46f60e484a5e9a9c (diff)
parent0f8647b0c2bce447f8ce27428de242727104ffb0 (diff)
downloadnixpkgs-d811555465785e76fc06872f4bb14d4dd1dfed8c.tar
nixpkgs-d811555465785e76fc06872f4bb14d4dd1dfed8c.tar.gz
nixpkgs-d811555465785e76fc06872f4bb14d4dd1dfed8c.tar.bz2
nixpkgs-d811555465785e76fc06872f4bb14d4dd1dfed8c.tar.lz
nixpkgs-d811555465785e76fc06872f4bb14d4dd1dfed8c.tar.xz
nixpkgs-d811555465785e76fc06872f4bb14d4dd1dfed8c.tar.zst
nixpkgs-d811555465785e76fc06872f4bb14d4dd1dfed8c.zip
Merge branch 'staging' into staging-next
Diffstat (limited to 'doc')
-rw-r--r--doc/hooks/meson.section.md35
-rw-r--r--doc/hooks/ninja.section.md2
2 files changed, 34 insertions, 3 deletions
diff --git a/doc/hooks/meson.section.md b/doc/hooks/meson.section.md
index fd7779e6468..dc261271326 100644
--- a/doc/hooks/meson.section.md
+++ b/doc/hooks/meson.section.md
@@ -1,16 +1,28 @@
 # Meson {#meson}
 
-Overrides the configure phase to run meson to generate Ninja files. To run these files, you should accompany Meson with ninja. By default, `enableParallelBuilding` is enabled as Meson supports parallel building almost everywhere.
+Overrides the configure, check, and install phases to run `meson setup`, `meson test`, and `meson install`.
+
+Meson is a meta-build system so you will need a secondary build system to run the generated build files in build phase. In Nixpkgs context, you will want to accompany Meson with ninja, which provides a [setup hook](#ninja) registering a ninja-based build phase.
+
+By default, `enableParallelBuilding` is enabled as Meson supports parallel building almost everywhere.
 
 ## Variables controlling Meson {#variables-controlling-meson}
 
 ### `mesonFlags` {#mesonflags}
 
-Controls the flags passed to meson.
+Controls the flags passed to `meson setup`.
+
+### `mesonCheckFlags` {#mesoncheckflags}
+
+Controls the flags passed to `meson test`.
+
+### `mesonInstallFlags` {#mesoninstallflags}
+
+Controls the flags passed to `meson install`.
 
 ### `mesonBuildType` {#mesonbuildtype}
 
-Which [`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to pass to Meson. We default to `plain`.
+Which [`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to pass to `meson setup`. We default to `plain`.
 
 ### `mesonAutoFeatures` {#mesonautofeatures}
 
@@ -23,3 +35,20 @@ What value to set [`-Dwrap_mode=`](https://mesonbuild.com/Builtin-options.html#c
 ### `dontUseMesonConfigure` {#dontusemesonconfigure}
 
 Disables using Meson’s `configurePhase`.
+
+### `dontUseMesonCheck` {#dontusemesoncheck}
+
+Disables using Meson’s `checkPhase`.
+
+### `dontUseMesonInstall` {#dontusemesoninstall}
+
+Disables using Meson’s `installPhase`.
+
+### `mesonInstallFlags` {#mesoninstallflags}
+
+Controls the flags passed to meson install.
+
+### `mesonInstallTags` (#mesoninstalltags)
+
+Tags specified here will be passed to Meson as via `--tags` during
+installation and controls which components will be installed.
diff --git a/doc/hooks/ninja.section.md b/doc/hooks/ninja.section.md
index 4b0e33feb5c..bbc94810880 100644
--- a/doc/hooks/ninja.section.md
+++ b/doc/hooks/ninja.section.md
@@ -1,3 +1,5 @@
 # ninja {#ninja}
 
 Overrides the build, install, and check phase to run ninja instead of make. You can disable this behavior with the `dontUseNinjaBuild`, `dontUseNinjaInstall`, and `dontUseNinjaCheck`, respectively. Parallel building is enabled by default in Ninja.
+
+Note that if the [Meson setup hook](#meson) is also active, Ninja's install and check phases will be disabled in favor of Meson's.