mention fastyaml loader in the docs

3 years ago · b0d29dd6ad
parent f5ffb0a1e9
commit b0d29dd6ad
1 changed files with 4 additions and 1 deletions
--- a/docs/markdown/Yaml-RefMan.md
+++ b/docs/markdown/Yaml-RefMan.md
@ -13,7 +13,10 @@ Additionally, multiple generation backends can be supported (besides the
 Markdown generator for mesonbuild.com).

 The generator that reads these YAML files is located in `docs/refman`, with the
-main executable being `docs/genrefman.py`.
+main executable being `docs/genrefman.py`.  By default `genrefman.py` will load
+the yaml manual using a strict subset of yaml at the cost of loading slowly.
+You may optionally disable all these safety checks using the `fastyaml` loader,
+which will significantly speed things up at the cost of being less correct.

 ## Linking to the Reference Manual