aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/snippets/meson_options.md7
-rw-r--r--docs/yaml/functions/dependency.yaml2
-rw-r--r--docs/yaml/functions/subproject.yaml4
3 files changed, 10 insertions, 3 deletions
diff --git a/docs/markdown/snippets/meson_options.md b/docs/markdown/snippets/meson_options.md
new file mode 100644
index 0000000..f9d582a
--- /dev/null
+++ b/docs/markdown/snippets/meson_options.md
@@ -0,0 +1,7 @@
+## Support for reading options from meson.options
+
+Support has been added for reading options from `meson.options` instead of
+`meson_options.txt`. These are equivalent, but not using the `.txt` extension
+for a build file has a few advantages, chief among them many tools and text
+editors expect a file with the `.txt` extension to be plain text files, not
+build scripts.
diff --git a/docs/yaml/functions/dependency.yaml b/docs/yaml/functions/dependency.yaml
index 2d9e366..85255b9 100644
--- a/docs/yaml/functions/dependency.yaml
+++ b/docs/yaml/functions/dependency.yaml
@@ -82,7 +82,7 @@ kwargs:
since: 0.38.0
description: |
An array of default option values
- that override those set in the subproject's `meson_options.txt`
+ that override those set in the subproject's `meson.options`
(like `default_options` in [[project]], they only have
effect when Meson is run for the first time, and command line
arguments override any default options in build files)
diff --git a/docs/yaml/functions/subproject.yaml b/docs/yaml/functions/subproject.yaml
index 4d19a31..14a778d 100644
--- a/docs/yaml/functions/subproject.yaml
+++ b/docs/yaml/functions/subproject.yaml
@@ -9,7 +9,7 @@ description: |
`${MESON_SOURCE_ROOT}/subprojects/foo`.
- `default_options` *(since 0.37.0)*: an array of default option values
- that override those set in the subproject's `meson_options.txt`
+ that override those set in the subproject's `meson.options`
(like `default_options` in `project`, they only have effect when
Meson is run for the first time, and command line arguments override
any default options in build files). *(since 0.54.0)*: `default_library`
@@ -45,7 +45,7 @@ kwargs:
since: 0.37.0
description: |
An array of default option values
- that override those set in the subproject's `meson_options.txt`
+ that override those set in the subproject's `meson.options`
(like `default_options` in [[project]], they only have effect when
Meson is run for the first time, and command line arguments override
any default options in build files). *(since 0.54.0)*: `default_library`