![]() - ExternalProgramHolder has path() method while CustomTargetHolder and BuildTargetHolder have full_path(). - The returned ExternalProgramHolder's path() method was broken, because build.Executable object has no get_path() method, it needs the backend. - find_program('overridden_prog', version : '>=1.0') was broken because it needs to execute the exe that is not yet built. Now assume the program has the (sub)project version. - If the version check fails, interpreter uses ExternalProgramHolder.get_name() for the error message but build.Executable does not implement get_name() method. |
||
---|---|---|
.. | ||
markdown | ||
theme/extra | ||
.editorconfig | ||
README.md | ||
genrelnotes.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 built_docs
$ ninja -C built_docs/ upload
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
Contributing to the documentation
Commits that only change documentation should have [skip ci]
in their commit message, so CI is not run (it is quite slow).
For example:
A commit message [skip ci]