Re: [libvirt PATCH] meson: Ask rst2html to strip comments
On Mon, Jun 07, 2021 at 04:52:41PM +0200, Pavel Hrdina wrote:
On Mon, Jun 07, 2021 at 04:39:15PM +0200, Michal Prívozník wrote:
> On 6/4/21 2:31 PM, Andrea Bolognani wrote:
> > [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 [...]
>
> I don't see this error. Do I need some very fresh version of something?
>
> $ rst2html.py --version
> rst2html.py (Docutils 0.16 [release], Python 3.9.4, on linux)
You need the incorrect rst2html tool, see this explanation for example:
https://gitlab.com/libvirt/libvirt/-/issues/139#note_528736524
Yeah, use of the incorrect rst2html version is my guess too; I
should, however, point out that I have not actually confirmed this
with the user... See [1] for the full conversation.
I'm not so sure about this patch. I think we should instead try
to
detect what rst2html is used and error out if it is not the one provided
by docutils project.
This is the simplest possible patch which solves the issue that the
user reported. In general, stripping the comments shouldn't cause any
problems, so I don't think applying this patch would be wrong.
That said, if you can come up with a sensible way to detect whether
the rst2html binary found on the system is the correct one and abort
otherwise, that would indeed be great! Do you want to give it a try
and see whether it's feasible with a reasonable amount of effort?
[1] https://listman.redhat.com/archives/libvirt-users/2021-June/msg00008.html
--
Andrea Bolognani / Red Hat / Virtualization