a45446b6e5
This was a nice idea in theory, but in practice it had various problems: - On the only platform where ldconfig is expected to be run, it is really slow, even when the user uses a non-default prefix and ldconfig doesn't even have permission to run, nor can do anything useful due to ld.so.conf state - On FreeBSD, it bricked the system: #9592 - On cross builds, it should not be used and broke installing, because ldconfig may not be runnable without binfmt + qemu: #9707 - it prints weird and confusing errors in the common "custom prefix" layout: #9241 Some of these problems can be or have been fixed. But it's a constant source of footguns and complaints and for something that was originally supposed to be just "it's the right thing to do anyway, so just do it automatically" it is entirely too risky. Ultimately I do not think there is justification for keeping this feature in since it doesn't actually make everyone happy. Better for users to decide whether they need this themselves. This is anyways the case for cmake and autotools and generally any other build system, so it should not be too intimidating... Fixes #9721 |
||
|---|---|---|
| .. | ||
| 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
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]