Fix: add special character substitution to blocks with ampersands
authorKienan Stewart <kstewart@efficios.com>
Thu, 19 Oct 2023 13:31:25 +0000 (09:31 -0400)
committerKienan Stewart <kstewart@efficios.com>
Thu, 19 Oct 2023 13:31:25 +0000 (09:31 -0400)
While there was no problem rendering HTML (using `make`), rendering
docbook/XML failed, eg:

Error: Cannot parse the DocBook XML file:
xmlParseEntityRef: no name, line 814, column
40 (lttng-docs-2.13m39rfphx.xml, line 814)

Snippet of the failed section:

```
<screen role="term">$ cd $(mktemp -d) &&
  wget http://lttng.org/files/lttng-modules/lttng-modules-latest-2.13.tar.bz2 &&
  tar -xf lttng-modules-latest-2.13.tar.bz2 &&
  cd lttng-modules-2.13.* &&
  make &&
  sudo make modules_install &&
  sudo depmod -a</screen>
```

The `tools/check.py` also fails without this modification.

Change-Id: I950fc010f05e8c3a3a1c8fecd963c23c62f19dc7
Signed-off-by: Kienan Stewart <kstewart@efficios.com>
2.13/lttng-docs-2.13.txt

index 530f1cf1d90db288826da6f52eb8a4fdf3d28242..ec6c70066f327fc8290fb3d51d7c11cfef7c770b 100644 (file)
@@ -575,7 +575,7 @@ Fedora{nbsp}39:
 . Download, build, and install the latest LTTng-modules{nbsp}{revision}:
 +
 --
-[role="term",subs="attributes"]
+[role="term",subs="attributes,specialcharacters"]
 ----
 $ cd $(mktemp -d) &&
   wget http://lttng.org/files/lttng-modules/lttng-modules-latest-{revision}.tar.bz2 &&
@@ -656,7 +656,7 @@ Alpine Linux{nbsp}3.16, Alpine Linux{nbsp}3.17, or Alpine Linux{nbsp}3.18:
 . Download, build, and install the latest LTTng-modules{nbsp}{revision}:
 +
 --
-[role="term",subs="attributes"]
+[role="term",subs="attributes,specialcharacters"]
 ----
 $ cd $(mktemp -d) &&
   wget http://lttng.org/files/lttng-modules/lttng-modules-latest-{revision}.tar.bz2 &&
This page took 0.025859 seconds and 4 git commands to generate.