The Meson Build System http://mesonbuild.com/

History

Eli Schwartz 8b573d7dc6 i18n.merge_file: do not disable in the absence of gettext tools Disabling targets because the tools used to build them aren't available is a pretty suspicious thing to do. Users who want this are probably, in general, advised to check themselves whether it is possible to build those targets with find_program(..., required: false) The i18n.gettext() invocation is a bit unusual because the product of running it is non-critical files, specifically, translation catalogs. If users don't have the tools needed to build them, they may not be able to use them either, because perhaps they have NLS disabled on their platform or it's difficult to put it in the bootstrap path. So, for this reason, it was made non-fatal and the message catalogs are just not created, and the resulting build is still perfectly usable unless you want to use it in another language, at which point it "works" but the text is all inscrutable to the end user, and that's a feature of the target platform. That's an acceptable tradeoff for translation catalogs. It is NOT an acceptable tradeoff for merge_file, which produces desktop files or MIME database catalogs or other files which have crucial roles to perform, without which the software in question simply doesn't work at all. In such cases, this just fails to install crucial files, users report bugs to the project in question, and the project adds `find_program('xgettext')` to guarantee the hard error due to lack of confidence in Meson. Fixes #6165 Fixes #8436		3 years ago
..
extensions	docs: Use a custom hotdoc extension for links to RefMan	3 years ago
markdown	i18n.merge_file: do not disable in the absence of gettext tools	3 years ago
refman	doc: fix regression that deleted all methods from the reference manual	3 years ago
theme/extra	modules/wayland: Add unstable_wayland module	3 years ago
yaml	document and raise an error for disallowed combination of install_headers args	3 years ago
.editorconfig	…
README.md	docs: fix bad advice in the README	3 years ago
genrefman.py	docs: Initial reference manual generator	3 years ago
genrelnotes.py	fix: Always explicitly set encoding for text files (fixes #8263 )	4 years ago
jsonvalidator.py	docs: Add a validator for the new JSON docs	3 years ago
meson.build	add man page generation to build	3 years ago
sitemap.txt	modules/wayland: Add unstable_wayland module	3 years ago

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]