summaryrefslogtreecommitdiffstats
path: root/docs/HACKING.md
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2021-05-19 13:22:25 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2021-05-19 13:53:51 +0200
commitc9d311c787f950e22b4accd62e0e3cb9c6a13966 (patch)
treed2557c75f55ff31c44376c792a877e0004593bac /docs/HACKING.md
parenttest: reintroduce m4 dependency for TEST-06-SELINUX (diff)
downloadsystemd-c9d311c787f950e22b4accd62e0e3cb9c6a13966.tar.xz
systemd-c9d311c787f950e22b4accd62e0e3cb9c6a13966.zip
docs: use {% raw %} to wrap jinja2 tags in documentation
As reported by @mrc0mmand: > Since https://github.com/systemd/systemd/commit/89f52a780e54b2eb0905a6e613f6d4afcb22256b#diff-b842e6ab4a95a695d9449d106f091e6a134d9eac8d2aee1cd8b169fcb6b3a98bR109 > the GH pages fail to build, since they use the Liquid templating language, > which coincidentally uses a very similar tags as jinja: > https://shopify.github.io/liquid/tags/control-flow/ > >> The tag elif on line 112 in HACKING.md is not a recognized Liquid tag.
Diffstat (limited to 'docs/HACKING.md')
-rw-r--r--docs/HACKING.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/HACKING.md b/docs/HACKING.md
index 4374ba097d..80bb2a00ba 100644
--- a/docs/HACKING.md
+++ b/docs/HACKING.md
@@ -114,11 +114,12 @@ Some source files are generated during build. We use two templating engines:
See https://mesonbuild.com/Reference-manual.html#configure_file for
details.
+{% raw %}
* most files are rendered using jinja2, with `{{VARIABLE}}` and `{% if … %}`,
`{% elif … %}`, `{% else … %}`, `{% endif … %}` blocks. `{# … #}` is a
jinja2 comment, i.e. that block will not be visible in the rendered
- output. `{% raw %} … {% endraw %}` creates a block where the jinja2 syntax
- is not interpreted.
+ output. `{% raw %} … `{% endraw %}`{{ '{' }}{{ '% endraw %' }}}` creates a block
+ where jinja2 syntax is not interpreted.
See https://jinja2docs.readthedocs.io/en/stable/templates.html#synopsis
for details.