[libvirt PATCH] meson: Ask rst2html to strip comments

Andrea Bolognani abologna at redhat.com
Fri Jun 4 12:31:08 UTC 2021


They can be problematic: in particular, the rst files generated
by keycodemapdb's keymap-gen contain things like

  To re-generate, run:
    keymap-gen --lang=rst --title=virkeycode-osx [...]

which result in xsltproc later choking with

  [1/12] Generating virkeyname-osx.html with a meson_exe.py custom command
  FAILED: docs/manpages/virkeyname-osx.html
  /usr/bin/meson --internal exe --capture docs/manpages/virkeyname-osx.html \
    /usr/bin/xsltproc [...] --nonet ../docs/subsite.xsl docs/manpages/virkeyname-osx.html.in
  docs/manpages/virkeyname-osx.html.in:17: parser error : Double hyphen within comment:
    keymap-gen --lang=rst --title=virkeyname-osx [...]
               ^

Stripping comments avoids the issue entirely.

Signed-off-by: Andrea Bolognani <abologna at redhat.com>
---
 docs/manpages/meson.build | 2 +-
 docs/meson.build          | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build
index 0fa93fad89..eda0aa8441 100644
--- a/docs/manpages/meson.build
+++ b/docs/manpages/meson.build
@@ -118,7 +118,7 @@ foreach data : docs_man_files
     html_in_file,
     input: rst_file,
     output: html_in_file,
-    command: [ rst2html_prog, '--stylesheet=', '--strict', '@INPUT@' ],
+    command: [ rst2html_prog, '--strip-comments', '--stylesheet=', '--strict', '@INPUT@' ],
     capture: true,
   )
 
diff --git a/docs/meson.build b/docs/meson.build
index f550629d8e..c94a3c7f13 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -185,7 +185,7 @@ docs_admin_api_xml = docs_api_generated[3]
 docs_rst2html_gen = generator(
   rst2html_prog,
   output: '@BASENAME at .html.in',
-  arguments: [ '--stylesheet=', '--strict', '@INPUT@' ],
+  arguments: [ '--strip-comments', '--stylesheet=', '--strict', '@INPUT@' ],
   capture: true,
 )
 
-- 
2.31.1




More information about the libvir-list mailing list