colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
52228e61b6
nixpkgs/doc/hooks/meson.section.md

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

55 lines
1.8 KiB
Markdown
Raw Normal View History

doc: make sure section depths are consecutive skipping heading levels (eg from # to ###, or starting at ###) is legal in pandoc, but not in nixos-render-docs. pandoc acts as though section levels *were* consecutive, nixos-render-docs prefers to tell people not to do that kind of thing because it can make documents more fragile.
2023-06-10 15:54:02 +00:00
# Meson {#meson}
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
meson.setupHook: prefer meson commands over ninja Meson now comes with its own set of commands for building, testing, installing etc., that by default wrap around Ninja. The reason to prefer using the Meson commands is that they take additional options (e.g. setting custom timeouts for tests — my motivation for this change). Here, I've modified the Meson setup hook so that Meson's test and install commands will be used instead of Ninja's when Meson's configurePhase is used. This restriction is to avoid starting to run Meson directly when dealing with custom build systems that wrap around Meson, like QEMU's. We don't use meson's compile command, as it just runs ninja, and that's handled fine by the existing Ninja setup hook. Naturally the Meson commands don't support entirely the same set of options that the Ninja ones did, but I checked through Nixpkgs to find any packages using Meson that used any options that wouldn't be picked up by this new system. I only found one, and it was just setting checkTarget = "test", which is the default value for Ninja and has no Meson equivalent (because we directly tell Meson to run the tests rather than going through a generic job system like Ninja). Link: https://github.com/NixOS/nixpkgs/issues/113829 Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-10-06 08:09:52 +00:00
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.
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
doc: make sure section depths are consecutive skipping heading levels (eg from # to ###, or starting at ###) is legal in pandoc, but not in nixos-render-docs. pandoc acts as though section levels *were* consecutive, nixos-render-docs prefers to tell people not to do that kind of thing because it can make documents more fragile.
2023-06-10 15:54:02 +00:00
## Variables controlling Meson {#variables-controlling-meson}
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
doc: make sure section depths are consecutive skipping heading levels (eg from # to ###, or starting at ###) is legal in pandoc, but not in nixos-render-docs. pandoc acts as though section levels *were* consecutive, nixos-render-docs prefers to tell people not to do that kind of thing because it can make documents more fragile.
2023-06-10 15:54:02 +00:00
### `mesonFlags` {#mesonflags}
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
meson.setupHook: prefer meson commands over ninja Meson now comes with its own set of commands for building, testing, installing etc., that by default wrap around Ninja. The reason to prefer using the Meson commands is that they take additional options (e.g. setting custom timeouts for tests — my motivation for this change). Here, I've modified the Meson setup hook so that Meson's test and install commands will be used instead of Ninja's when Meson's configurePhase is used. This restriction is to avoid starting to run Meson directly when dealing with custom build systems that wrap around Meson, like QEMU's. We don't use meson's compile command, as it just runs ninja, and that's handled fine by the existing Ninja setup hook. Naturally the Meson commands don't support entirely the same set of options that the Ninja ones did, but I checked through Nixpkgs to find any packages using Meson that used any options that wouldn't be picked up by this new system. I only found one, and it was just setting checkTarget = "test", which is the default value for Ninja and has no Meson equivalent (because we directly tell Meson to run the tests rather than going through a generic job system like Ninja). Link: https://github.com/NixOS/nixpkgs/issues/113829 Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-10-06 08:09:52 +00:00
Controls the flags passed to `meson setup`.
doc: fix heading levels of Meson hook documentation Fixes: 10f35ff05df1 ("meson.setupHook: prefer meson commands over ninja")
2023-10-21 08:41:21 +00:00
### `mesonCheckFlags` {#mesoncheckflags}
meson.setupHook: prefer meson commands over ninja Meson now comes with its own set of commands for building, testing, installing etc., that by default wrap around Ninja. The reason to prefer using the Meson commands is that they take additional options (e.g. setting custom timeouts for tests — my motivation for this change). Here, I've modified the Meson setup hook so that Meson's test and install commands will be used instead of Ninja's when Meson's configurePhase is used. This restriction is to avoid starting to run Meson directly when dealing with custom build systems that wrap around Meson, like QEMU's. We don't use meson's compile command, as it just runs ninja, and that's handled fine by the existing Ninja setup hook. Naturally the Meson commands don't support entirely the same set of options that the Ninja ones did, but I checked through Nixpkgs to find any packages using Meson that used any options that wouldn't be picked up by this new system. I only found one, and it was just setting checkTarget = "test", which is the default value for Ninja and has no Meson equivalent (because we directly tell Meson to run the tests rather than going through a generic job system like Ninja). Link: https://github.com/NixOS/nixpkgs/issues/113829 Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-10-06 08:09:52 +00:00
Controls the flags passed to `meson test`.
doc: fix heading levels of Meson hook documentation Fixes: 10f35ff05df1 ("meson.setupHook: prefer meson commands over ninja")
2023-10-21 08:41:21 +00:00
### `mesonInstallFlags` {#mesoninstallflags}
meson.setupHook: prefer meson commands over ninja Meson now comes with its own set of commands for building, testing, installing etc., that by default wrap around Ninja. The reason to prefer using the Meson commands is that they take additional options (e.g. setting custom timeouts for tests — my motivation for this change). Here, I've modified the Meson setup hook so that Meson's test and install commands will be used instead of Ninja's when Meson's configurePhase is used. This restriction is to avoid starting to run Meson directly when dealing with custom build systems that wrap around Meson, like QEMU's. We don't use meson's compile command, as it just runs ninja, and that's handled fine by the existing Ninja setup hook. Naturally the Meson commands don't support entirely the same set of options that the Ninja ones did, but I checked through Nixpkgs to find any packages using Meson that used any options that wouldn't be picked up by this new system. I only found one, and it was just setting checkTarget = "test", which is the default value for Ninja and has no Meson equivalent (because we directly tell Meson to run the tests rather than going through a generic job system like Ninja). Link: https://github.com/NixOS/nixpkgs/issues/113829 Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-10-06 08:09:52 +00:00
Controls the flags passed to `meson install`.
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
doc: make sure section depths are consecutive skipping heading levels (eg from # to ###, or starting at ###) is legal in pandoc, but not in nixos-render-docs. pandoc acts as though section levels *were* consecutive, nixos-render-docs prefers to tell people not to do that kind of thing because it can make documents more fragile.
2023-06-10 15:54:02 +00:00
### `mesonBuildType` {#mesonbuildtype}
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
meson.setupHook: prefer meson commands over ninja Meson now comes with its own set of commands for building, testing, installing etc., that by default wrap around Ninja. The reason to prefer using the Meson commands is that they take additional options (e.g. setting custom timeouts for tests — my motivation for this change). Here, I've modified the Meson setup hook so that Meson's test and install commands will be used instead of Ninja's when Meson's configurePhase is used. This restriction is to avoid starting to run Meson directly when dealing with custom build systems that wrap around Meson, like QEMU's. We don't use meson's compile command, as it just runs ninja, and that's handled fine by the existing Ninja setup hook. Naturally the Meson commands don't support entirely the same set of options that the Ninja ones did, but I checked through Nixpkgs to find any packages using Meson that used any options that wouldn't be picked up by this new system. I only found one, and it was just setting checkTarget = "test", which is the default value for Ninja and has no Meson equivalent (because we directly tell Meson to run the tests rather than going through a generic job system like Ninja). Link: https://github.com/NixOS/nixpkgs/issues/113829 Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-10-06 08:09:52 +00:00
Which [`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to pass to `meson setup`. We default to `plain`.
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
doc: make sure section depths are consecutive skipping heading levels (eg from # to ###, or starting at ###) is legal in pandoc, but not in nixos-render-docs. pandoc acts as though section levels *were* consecutive, nixos-render-docs prefers to tell people not to do that kind of thing because it can make documents more fragile.
2023-06-10 15:54:02 +00:00
### `mesonAutoFeatures` {#mesonautofeatures}
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
What value to set [`-Dauto_features=`](https://mesonbuild.com/Builtin-options.html#core-options) to. We default to `enabled`.
doc: make sure section depths are consecutive skipping heading levels (eg from # to ###, or starting at ###) is legal in pandoc, but not in nixos-render-docs. pandoc acts as though section levels *were* consecutive, nixos-render-docs prefers to tell people not to do that kind of thing because it can make documents more fragile.
2023-06-10 15:54:02 +00:00
### `mesonWrapMode` {#mesonwrapmode}
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
What value to set [`-Dwrap_mode=`](https://mesonbuild.com/Builtin-options.html#core-options) to. We default to `nodownload` as we disallow network access.
doc: make sure section depths are consecutive skipping heading levels (eg from # to ###, or starting at ###) is legal in pandoc, but not in nixos-render-docs. pandoc acts as though section levels *were* consecutive, nixos-render-docs prefers to tell people not to do that kind of thing because it can make documents more fragile.
2023-06-10 15:54:02 +00:00
### `dontUseMesonConfigure` {#dontusemesonconfigure}
doc: Move non-stdenv hooks out of stdenv chapter
2022-10-13 13:36:04 +00:00
Disables using Meson’s `configurePhase`.
meson.setupHook: prefer meson commands over ninja Meson now comes with its own set of commands for building, testing, installing etc., that by default wrap around Ninja. The reason to prefer using the Meson commands is that they take additional options (e.g. setting custom timeouts for tests — my motivation for this change). Here, I've modified the Meson setup hook so that Meson's test and install commands will be used instead of Ninja's when Meson's configurePhase is used. This restriction is to avoid starting to run Meson directly when dealing with custom build systems that wrap around Meson, like QEMU's. We don't use meson's compile command, as it just runs ninja, and that's handled fine by the existing Ninja setup hook. Naturally the Meson commands don't support entirely the same set of options that the Ninja ones did, but I checked through Nixpkgs to find any packages using Meson that used any options that wouldn't be picked up by this new system. I only found one, and it was just setting checkTarget = "test", which is the default value for Ninja and has no Meson equivalent (because we directly tell Meson to run the tests rather than going through a generic job system like Ninja). Link: https://github.com/NixOS/nixpkgs/issues/113829 Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-10-06 08:09:52 +00:00
doc: fix heading levels of Meson hook documentation Fixes: 10f35ff05df1 ("meson.setupHook: prefer meson commands over ninja")
2023-10-21 08:41:21 +00:00
### `dontUseMesonCheck` {#dontusemesoncheck}
meson.setupHook: prefer meson commands over ninja Meson now comes with its own set of commands for building, testing, installing etc., that by default wrap around Ninja. The reason to prefer using the Meson commands is that they take additional options (e.g. setting custom timeouts for tests — my motivation for this change). Here, I've modified the Meson setup hook so that Meson's test and install commands will be used instead of Ninja's when Meson's configurePhase is used. This restriction is to avoid starting to run Meson directly when dealing with custom build systems that wrap around Meson, like QEMU's. We don't use meson's compile command, as it just runs ninja, and that's handled fine by the existing Ninja setup hook. Naturally the Meson commands don't support entirely the same set of options that the Ninja ones did, but I checked through Nixpkgs to find any packages using Meson that used any options that wouldn't be picked up by this new system. I only found one, and it was just setting checkTarget = "test", which is the default value for Ninja and has no Meson equivalent (because we directly tell Meson to run the tests rather than going through a generic job system like Ninja). Link: https://github.com/NixOS/nixpkgs/issues/113829 Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-10-06 08:09:52 +00:00
Disables using Meson’s `checkPhase`.
doc: fix heading levels of Meson hook documentation Fixes: 10f35ff05df1 ("meson.setupHook: prefer meson commands over ninja")
2023-10-21 08:41:21 +00:00
### `dontUseMesonInstall` {#dontusemesoninstall}
meson.setupHook: prefer meson commands over ninja Meson now comes with its own set of commands for building, testing, installing etc., that by default wrap around Ninja. The reason to prefer using the Meson commands is that they take additional options (e.g. setting custom timeouts for tests — my motivation for this change). Here, I've modified the Meson setup hook so that Meson's test and install commands will be used instead of Ninja's when Meson's configurePhase is used. This restriction is to avoid starting to run Meson directly when dealing with custom build systems that wrap around Meson, like QEMU's. We don't use meson's compile command, as it just runs ninja, and that's handled fine by the existing Ninja setup hook. Naturally the Meson commands don't support entirely the same set of options that the Ninja ones did, but I checked through Nixpkgs to find any packages using Meson that used any options that wouldn't be picked up by this new system. I only found one, and it was just setting checkTarget = "test", which is the default value for Ninja and has no Meson equivalent (because we directly tell Meson to run the tests rather than going through a generic job system like Ninja). Link: https://github.com/NixOS/nixpkgs/issues/113829 Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2023-10-06 08:09:52 +00:00
Disables using Meson’s `installPhase`.
meson: introduce mesonInstallTags Projects building with meson are currently installTargets. Map these to install tags, which are roughly equivalent. This allows projects to selectively install components.
2023-10-19 10:23:31 +00:00
### `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.
Reference in New Issue Copy Permalink