![]() 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 |
||
---|---|---|
.. | ||
extensions | ||
markdown | ||
refman | ||
theme/extra | ||
yaml | ||
.editorconfig | ||
README.md | ||
genrefman.py | ||
genrelnotes.py | ||
jsonvalidator.py | ||
meson.build | ||
sitemap.txt |
README.md
Meson Documentation
Build dependencies
Meson uses itself and hotdoc for generating documentation.
Minimum required version of hotdoc is 0.8.9.
Instructions on how to install hotdoc are here.
Building the documentation
From the Meson repository root dir:
$ cd docs/
$ meson setup built_docs/
$ ninja -C built_docs/
Now you should be able to open the documentation locally
built_docs/Meson documentation-doc/html/index.html
Upload
Meson uses the git-upload hotdoc plugin which basically removes the html pages and replaces with the new content.
You can simply run:
$ ninja -C built_docs/ upload