aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/snippets
diff options
context:
space:
mode:
authorXavier Claessens <xavier.claessens@collabora.com>2018-04-11 10:13:14 -0400
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-06-18 04:57:32 +0000
commite565945253662ef6e2151241b6686a999b78a43d (patch)
tree72c98fe3715acbb6704bcd80c902e9b49bb2a65b /docs/markdown/snippets
parent5290f41f31439180b15600bca4ce4456983e3900 (diff)
downloadmeson-e565945253662ef6e2151241b6686a999b78a43d.zip
meson-e565945253662ef6e2151241b6686a999b78a43d.tar.gz
meson-e565945253662ef6e2151241b6686a999b78a43d.tar.bz2
Add UserFeatureOption type
This is a special type of option to be passed to most 'required' keyword arguments. It adds a 3rd state to the traditional boolean value to cause those methods to always return not-found even if the dependency could be found. Since integrators doesn't want enabled features to be a surprise there is a global option "auto_features" to enable or disable all automatic features.
Diffstat (limited to 'docs/markdown/snippets')
-rw-r--r--docs/markdown/snippets/feature_options.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/markdown/snippets/feature_options.md b/docs/markdown/snippets/feature_options.md
new file mode 100644
index 0000000..22d9201
--- /dev/null
+++ b/docs/markdown/snippets/feature_options.md
@@ -0,0 +1,10 @@
+## New feature option type
+
+A new type of option can be defined in `meson_options.txt` for the traditional
+`enabled / disabled / auto` tristate. The value of this option can be passed to
+the `required` keyword argument of functions `dependency()`, `find_library()`,
+`find_program()` and `add_languages()`.
+
+A new global option `auto_features` has been added to override the value of all
+`auto` features. It is intended to be used by packagers to have full control on
+which feature must be enabled or disabled.