meson/docs
Dylan Baker 78e37c4953 Accept builtin options with -D when making initial meson call
Currently meson only accepts `-Dopt=value` for builtin options when
calling `meson configure` and `--opt=value` for builtin options when
calling `meson` initially. This is a confusing behavior, and users only
get a small warning at the top of a potentially long configuration
summary to catch this.

This has confused end users and developers alike, there are at least 5
duplicates of the bug this fixes, and I have personally been asked about
this more times than I can count. The help documentation doesn't make
it clear that -D cannot be used to set options like prefix and bindir.

This adds support for -D options to the initial meson call, but not --
options to the meson configure call. I think it's better to have one way
to do things, and -- options are kinda one off while -D is used
everywhere else, so lets stick with that.

Related #969
2018-04-17 11:32:26 -07:00
..
images docs: Prettier screenshot in tutorial 2017-10-04 01:00:37 +03:00
markdown Accept builtin options with -D when making initial meson call 2018-04-17 11:32:26 -07:00
theme/extra Removed duplicate title in doc theme. 2017-08-31 21:59:11 +03:00
README.md docs: clarify where hotdoc should be run 2017-05-08 20:11:47 -04:00
hotdoc.json Fix web site upload repository. 2017-04-26 22:53:26 +03:00
sitemap.txt Updated information for new release. 2018-03-04 20:27:34 +02:00

README.md

Building the documentation

  1. Get hotdoc (0.8.9 required)

  2. Run hotdoc in the docs/ directory:

    hotdoc run

Upload

We are using the git-upload hotdoc plugin which basically removes the html pages and replaces with the new content.

You can simply run:

hotdoc run --git-upload-activate