]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
docs: use {% raw %} to wrap jinja2 tags in documentation
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Wed, 19 May 2021 11:22:25 +0000 (13:22 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Wed, 19 May 2021 11:53:51 +0000 (13:53 +0200)
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.

docs/HACKING.md

index 4374ba097d69fdc967f358d05438e667d3dbdbce..80bb2a00bab54367ee53ffb336e1b0f44a17404e 100644 (file)
@@ -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.