aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/snippets
diff options
context:
space:
mode:
authorDylan Baker <dylan@pnwbakers.com>2022-12-14 10:59:36 -0800
committerJussi Pakkanen <jpakkane@gmail.com>2023-03-28 15:01:10 +0300
commit4a014d17240f50059e20ccae3e9faaa395bdbf98 (patch)
tree4b2ae56e23db1cee4d04d602bfb1e154259cba36 /docs/markdown/snippets
parent65482497d326b0026eb11419d178d19b20ebe58b (diff)
downloadmeson-4a014d17240f50059e20ccae3e9faaa395bdbf98.zip
meson-4a014d17240f50059e20ccae3e9faaa395bdbf98.tar.gz
meson-4a014d17240f50059e20ccae3e9faaa395bdbf98.tar.bz2
Add support for meson.options as a replacement for meson_options.txt
We will still try to load `meson_options.txt` if `meson.options` doesn't exist. Because there are some advantages to using `meson.options` even with older versions of meson (such as better text editor handling) we will not warn about the existence of a `meson.options` file if a `meson_options.txt` file or symlink also exists. The name `meson.options` was picked instead of alternative proposals, such as `meson_options.build` for a couple of reasons: 1. meson.options is shorter 2. While the syntax is the same, only the `option()` function may be called in meson.options, while, it may not be called in meson.build 3. While the two files share a syntax and elementary types (strings, arrays, etc), they have different purposes: `meson.build` declares build targets, `meson.options` declares options. This is similar to the difference between C's `.c` and `.h` extensions. As an implementation detail `Interpreter.option_file` has been removed, as it is used exactly once, in the `project()` call to read the options, and we can just calculate it there and not store it. Fixes: #11176
Diffstat (limited to 'docs/markdown/snippets')
-rw-r--r--docs/markdown/snippets/meson_options.md7
1 files changed, 7 insertions, 0 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.