meson/docs
Peter Kjellerstedt 6226ac26ef minstall: Correctly set uid/gid of installed files
In commit caab4d3d, the uid and gid arguments passed to os.chown() by
set_chown() were accidentally swapped, causing files to end up with
incorrect owner/group if the owner and group are not the same.

Also update the documentation to better indicate which argument to
install_mode is which.

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
2021-03-06 13:29:29 +02:00
..
markdown minstall: Correctly set uid/gid of installed files 2021-03-06 13:29:29 +02:00
theme/extra modules: Add an unstable-rust module 2021-01-05 15:10:50 -08:00
.editorconfig editorconfig: Use tabs for sitemap.txt [skip ci] 2018-11-08 20:38:39 +02:00
README.md Update Meson docs README [skip ci] 2018-09-27 01:43:22 -07:00
genrelnotes.py mass rewrite of string formatting to use f-strings everywhere 2021-03-04 17:16:11 -05:00
meson.build Hotdoc: use template for Commands.md instead of generating the entire file (#8154) 2021-01-10 14:48:34 +02:00
sitemap.txt Set up release 0.57. 2021-02-14 21:28:44 +02:00

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]