zqqw / pakku

Pacman wrapper with AUR support
GNU General Public License v3.0
39 stars 3 forks source link

man pages won't build with latest asciidoc 10.1.1-1 #20

Open zqqw opened 2 years ago

zqqw commented 2 years ago

Having just updated the man pages I thought this was something I had done, but no - and it was building fine recently when I was testing this, downgrading asciidoc to 9.1.1-4 sees it build again. Adding -v to the a2x command options in pakku/Makefile gives a little more output, but not sure of the fix yet...

${MAN_PAGES:=.in}: ${MAN_PAGES:=.txt}
        @echo "GEN: $@"
        @a2x \
        -v \
        --doctype manpage \
zqqw commented 2 years ago

It seems that changing line 72 of Makefile from: -a manmanual='Pakku Manual' \ to -a manmanual='Pakku_Manual' \ provides a workaround to this, because the new asciidoc can't parse the space correctly.

$ a2x -v --doctype manpage --format manpage --asciidoc-opts="-v -f doc/asciidoc.conf -a manmanual='Pakku Manual' -a mansource='Pakku' -a manversion=0.14-36g2
2678d2" doc/pakku.conf.5.txt
a2x: args: ['-v', '--doctype', 'manpage', '--format', 'manpage', "--asciidoc-opts=-v -f doc/asciidoc.conf -a manmanual='Pakku Manual' -a mansource='Pakku' -a
manversion=0.14-36-g22678d2", 'doc/pakku.conf.5.txt']
a2x: resource files: []
a2x: resource directories: ['/usr/lib/python3.10/site-packages/asciidoc/resources/stylesheets']
a2x: executing: asciidoc [['-v', '-f', 'doc/asciidoc.conf', '-a', "manmanual='Pakku", "Manual'", '-a', "mansource='Pakku'", '-a', 'manversion=0.14-36-g22678d2
'], ('--doctype', 'manpage'), ('--verbose',), ('--backend', 'docbook'), ('-a', 'a2x-format=manpage'), ('--out-file', '/tmp/pakku-git/src/3pakku/doc/pakku.conf
.5.xml')]

Man page:     asciidoc --help manpage
Syntax:       asciidoc --help syntax

$ a2x -v --doctype manpage --format manpage --asciidoc-opts="-v -f doc/asciidoc.conf -a manmanual='Pakku_Manual' -a mansource='Pakku' -a manversion=0.14-36-g2
2678d2" doc/pakku.conf.5.txt
a2x: args: ['-v', '--doctype', 'manpage', '--format', 'manpage', "--asciidoc-opts=-v -f doc/asciidoc.conf -a manmanual='Pakku_Manual' -a mansource='Pakku' -a
manversion=0.14-36-g22678d2", 'doc/pakku.conf.5.txt']
a2x: resource files: []
a2x: resource directories: ['/usr/lib/python3.10/site-packages/asciidoc/resources/stylesheets']
a2x: executing: asciidoc [['-v', '-f', 'doc/asciidoc.conf', '-a', "manmanual='Pakku_Manual'", '-a', "mansource='Pakku'", '-a', 'manversion=0.14-36-g22678d2'],
 ('--doctype', 'manpage'), ('--verbose',), ('--backend', 'docbook'), ('-a', 'a2x-format=manpage'), ('--out-file', '/tmp/pakku-git/src/3pakku/doc/pakku.conf.5.
xml')]
a2x: executing: "xmllint" --nonet --noout --valid "/tmp/pakku-git/src/3pakku/doc/pakku.conf.5.xml"

a2x: chdir /tmp/pakku-git/src/3pakku/doc
a2x: executing: "xsltproc"  --stringparam callout.graphics 0 --stringparam navig.graphics 0 --stringparam admon.textlabel 1 --stringparam admon.graphics 0  "/
usr/lib/python3.10/site-packages/asciidoc/resources/docbook-xsl/manpage.xsl" "/tmp/pakku-git/src/3pakku/doc/pakku.conf.5.xml"

Warn: meta author : no refentry/info/author                        pakku.conf
Note: meta author : see http://www.docbook.org/tdg5/en/html/autho  pakku.conf
Warn: meta author : no author data, so inserted a fixme            pakku.conf
Note: Writing pakku.conf.5

a2x: chdir /tmp/pakku-git/src/3pakku
a2x: deleting /tmp/pakku-git/src/3pakku/doc/pakku.conf.5.xml
zqqw commented 2 years ago

https://github.com/zqqw/pakku/commit/8194d6d9b82c765703a94ed612c15befa92379aa That commit effectively resolves this and it should build with both the older and newer versions of asciidoc. Possibly it might get fixed in future releases of asciidoc so it could be reverted, although it will take a while for the versions to work through Manjaro for example. All it does is change the man page title at the top of the page from "Pakku Manual" to "Pakku_Manual" with an underscore instead of a space so it's not very important either way. So the situation can be reviewed in future - perhaps in a few months or next year, this issue is left open as a reminder.