HTML comments containing double dashes "--" give an error when building libvirt git
Created originally on Bitbucket by egphilippov (Eugene Philippov)
Such HTML comment is produced by https://github.com/qemu/keycodemapdb/blob/master/tools/keymap-gen#L324 and then (it seems) applying rst2html5
.
These errors can be observed by cloning git://libvirt.org/libvirt.git
and building it:
./autogen.sh --system
mkdir tmpbuild && cd tmpbuild
../configure --prefix=/usr/local/libvirt --sysconfdir=/etc --localstatedir=/var --with-driver-modules --enable-shared
make
Its log:
[…]
Making all in docs
make[2]: Entering directory '/home/user/git/libvirt/tmpbuild/docs'
GEN manpages/virt-pki-validate.1
GEN manpages/virt-xml-validate.1
GEN manpages/virt-admin.1
GEN manpages/virsh.1
GEN manpages/virt-host-validate.1
GEN manpages/virt-login-shell.1
GEN manpages/virkeycode-linux.rst
GEN manpages/virkeycode-osx.rst
GEN manpages/virkeycode-atset1.rst
GEN manpages/virkeycode-atset2.rst
GEN manpages/virkeycode-atset3.rst
GEN manpages/virkeycode-xtkbd.rst
GEN manpages/virkeycode-usb.rst
GEN manpages/virkeycode-win32.rst
GEN manpages/virkeycode-qnum.rst
GEN manpages/virkeyname-linux.rst
GEN manpages/virkeyname-osx.rst
GEN manpages/virkeyname-win32.rst
GEN manpages/libvirtd.8
GEN manpages/virtlockd.8
GEN manpages/virtlogd.8
GEN apibuild.py.stamp
GEN aclperms.htmlinc
GEN news.html.in
GEN manpages/virkeycode-linux.html.in
GEN manpages/virkeycode-osx.html.in
GEN manpages/virkeycode-atset1.html.in
GEN manpages/virkeycode-atset2.html.in
GEN manpages/virkeycode-atset3.html.in
GEN manpages/virkeycode-xtkbd.html.in
GEN manpages/virkeycode-usb.html.in
GEN manpages/virkeycode-win32.html.in
GEN manpages/virkeycode-qnum.html.in
GEN manpages/virkeyname-linux.html.in
GEN manpages/virkeyname-osx.html.in
GEN manpages/virkeyname-win32.html.in
GEN manpages/libvirtd.html.tmp
GEN manpages/virtlockd.html.tmp
GEN manpages/virtlogd.html.tmp
GEN manpages/virt-sanlock-cleanup.html.tmp
GEN manpages/virkeycode-linux.7
GEN manpages/virkeycode-osx.7
GEN manpages/virkeycode-atset1.7
touch apibuild.py.stamp
GEN manpages/virkeycode-atset2.7
GEN manpages/virkeycode-atset3.7
GEN manpages/virkeycode-xtkbd.7
GEN manpages/virkeycode-usb.7
GEN manpages/virkeycode-win32.7
GEN manpages/virkeycode-qnum.7
GEN manpages/virkeyname-linux.7
GEN manpages/virkeyname-osx.7
GEN manpages/virkeyname-win32.7
GEN html/index.html
GEN html/index-admin.html
GEN html/index-qemu.html
GEN html/index-lxc.html
GEN hvsupport.html.in
GEN news.html.tmp
GEN drvlxc.html.tmp
GEN securityprocess.html.tmp
GEN news-2013.html.tmp
GEN formatdomain.html.tmp
GEN python.html.tmp
GEN drvqemu.html.tmp
GEN formatnetworkport.html.tmp
GEN testtck.html.tmp
GEN drivers.html.tmp
GEN api_extension.html.tmp
GEN remote.html.tmp
GEN tlscerts.html.tmp
GEN errors.html.tmp
GEN format.html.tmp
GEN news-2011.html.tmp
GEN drvopenvz.html.tmp
GEN drvhyperv.html.tmp
GEN drvremote.html.tmp
GEN devguide.html.tmp
GEN docs.html.tmp
GEN downloads.html.tmp
GEN formatstorageencryption.html.tmp
GEN acl.html.tmp
GEN drvvirtuozzo.html.tmp
GEN auditlog.html.tmp
GEN bugs.html.tmp
GEN dbus.html.tmp
GEN formatstorage.html.tmp
GEN api.html.tmp
GEN formatnetwork.html.tmp
GEN auth.html.tmp
GEN news-2010.html.tmp
GEN compiling.html.tmp
GEN drvvbox.html.tmp
GEN news-2015.html.tmp
GEN contribute.html.tmp
GEN index.html.tmp
GEN drvxen.html.tmp
GEN news-2008.html.tmp
GEN drvnodedev.html.tmp
GEN hooks.html.tmp
GEN formatcheckpoint.html.tmp
GEN news-2009.html.tmp
GEN firewall.html.tmp
GEN apps.html.tmp
GEN news-2014.html.tmp
GEN news-2016.html.tmp
GEN support.html.tmp
GEN contact.html.tmp
GEN drvtest.html.tmp
GEN news-2007.html.tmp
GEN goals.html.tmp
GEN formatnwfilter.html.tmp
GEN 404.html.tmp
GEN storage.html.tmp
GEN formatstoragecaps.html.tmp
GEN php.html.tmp
GEN architecture.html.tmp
GEN drvvmware.html.tmp
GEN testapi.html.tmp
GEN kbase.html.tmp
GEN windows.html.tmp
GEN formatbackup.html.tmp
GEN formatnode.html.tmp
GEN migration.html.tmp
GEN news-2005.html.tmp
GEN platforms.html.tmp
GEN governance.html.tmp
GEN nss.html.tmp
GEN aclpolkit.html.tmp
GEN news-2012.html.tmp
GEN logging.html.tmp
GEN news-2006.html.tmp
GEN internals.html.tmp
GEN drvesx.html.tmp
GEN strategy.html.tmp
GEN formatsnapshot.html.tmp
GEN bindings.html.tmp
GEN cgroups.html.tmp
GEN virshcmdref.html.tmp
GEN formatcaps.html.tmp
GEN formatsecret.html.tmp
GEN drvbhyve.html.tmp
GEN pci-hotplug.html.tmp
GEN csharp.html.tmp
GEN java.html.tmp
GEN hacking.html.tmp
GEN formatdomaincaps.html.tmp
GEN uri.html.tmp
GEN testsuites.html.tmp
GEN styleguide.html.tmp
GEN internals/locking.html.tmp
GEN internals/rpc.html.tmp
GEN internals/eventloop.html.tmp
GEN internals/command.html.tmp
GEN kbase/secureusage.html.tmp
GEN kbase/backing_chains.html.tmp
GEN kbase/locking.html.tmp
GEN kbase/domainstatecapture.html.tmp
GEN kbase/launch_security_sev.html.tmp
GEN kbase/locking-sanlock.html.tmp
GEN kbase/rpm-deployment.html.tmp
GEN kbase/locking-lockd.html.tmp
GEN manpages/index.html.tmp
GEN manpages/virt-pki-validate.html.tmp
GEN manpages/virt-xml-validate.html.tmp
GEN manpages/virt-admin.html.tmp
GEN manpages/virsh.html.tmp
GEN manpages/virt-host-validate.html.tmp
GEN manpages/virt-login-shell.html.tmp
GEN manpages/virkeycode-linux.html.tmp
GEN manpages/virkeycode-osx.html.tmp
GEN manpages/virkeycode-atset1.html.tmp
GEN manpages/virkeycode-atset2.html.tmp
manpages/virkeycode-linux.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-linux --subtitle=Key code values for
^
manpages/virkeycode-linux.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-linux --subtitle=Key code values for
^
manpages/virkeycode-linux.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-linux --subtitle=Key code values for
^
unable to parse manpages/virkeycode-linux.html.in
manpages/virkeycode-atset1.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-atset1 --subtitle=Key code values for
^
manpages/virkeycode-atset1.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-atset1 --subtitle=Key code values for
^
manpages/virkeycode-atset1.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-atset1 --subtitle=Key code values for
^
unable to parse manpages/virkeycode-atset1.html.in
GEN manpages/virkeycode-atset3.html.tmp
manpages/virkeycode-osx.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-osx --subtitle=Key code values for os
^
manpages/virkeycode-osx.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-osx --subtitle=Key code values for os
^
manpages/virkeycode-osx.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-osx --subtitle=Key code values for os
^
unable to parse manpages/virkeycode-osx.html.in
Makefile:2657: recipe for target 'manpages/virkeycode-linux.html.tmp' failed
make[2]: *** [manpages/virkeycode-linux.html.tmp] Error 1
make[2]: *** Waiting for unfinished jobs....
Makefile:2657: recipe for target 'manpages/virkeycode-atset1.html.tmp' failed
make[2]: *** [manpages/virkeycode-atset1.html.tmp] Error 1
Makefile:2657: recipe for target 'manpages/virkeycode-osx.html.tmp' failed
make[2]: *** [manpages/virkeycode-osx.html.tmp] Error 1
manpages/virkeycode-atset2.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-atset2 --subtitle=Key code values for
^
manpages/virkeycode-atset2.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-atset2 --subtitle=Key code values for
^
manpages/virkeycode-atset2.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-atset2 --subtitle=Key code values for
^
unable to parse manpages/virkeycode-atset2.html.in
Makefile:2657: recipe for target 'manpages/virkeycode-atset2.html.tmp' failed
make[2]: *** [manpages/virkeycode-atset2.html.tmp] Error 1
manpages/virkeycode-atset3.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-atset3 --subtitle=Key code values for
^
manpages/virkeycode-atset3.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-atset3 --subtitle=Key code values for
^
manpages/virkeycode-atset3.html.in:14: parser error : Double hyphen within comment: <!-- This file is auto-generated from keymaps.csv
Data
keymap-gen --lang=rst --title=virkeycode-atset3 --subtitle=Key code values for
^
unable to parse manpages/virkeycode-atset3.html.in
Makefile:2657: recipe for target 'manpages/virkeycode-atset3.html.tmp' failed
make[2]: *** [manpages/virkeycode-atset3.html.tmp] Error 1
make[2]: *** wait: No child processes. Stop.
Makefile:1959: recipe for target 'all-recursive' failed
make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory '/home/user/git/libvirt/tmpbuild'
Makefile:1852: recipe for target 'all' failed
make: *** [all] Error 2
Sample of faulty .rst file is attached.
Please close this bug as INVALID if it’s not rst2html5 fault.