[Bug 27315] New: The man pages for the command line utilities do not display properly
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Bug ID: 27315 Summary: The man pages for the command line utilities do not display properly Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: minor Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: a.roussos@dataly.gr QA Contact: testopia@bugs.koha-community.org Created attachment 114741 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=114741&action=edit problem with koha-list man page When viewing the man page for the `koha-list` command, the output does not appear correctly: there appears to be a "staircase" like effect on the text. The same is true for all other man pages, actually. Oddly enough, on an older Koha install of mine (19.11.03) the man page for `koha-list` displays fine. I attach a screenshot which displays the problem. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |dcook@prosentient.com.au -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 --- Comment #1 from David Cook <dcook@prosentient.com.au> --- You might want to email the koha-devel listserv about this one too, since someone there might know more about why this is happening. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Magnus Enger <magnus@libriotech.no> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |magnus@libriotech.no -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 --- Comment #2 from Magnus Enger <magnus@libriotech.no> --- I see this problem with Koha 19.11.11, on Debian 9.13. It looks like this affects all our man pages, but I don't think we changed anything in all of them? I suspect the problem is how the man pages are generated from our DocBook files. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@bugs.koha-c | |ommunity.org --- Comment #3 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- It's coming from the spaces between the start of the line and the XML tags. However I have no idea why this problem appeared recently. I have tried with the example at https://tdg.docbook.org/tdg/5.2/refentry.html and I see the same problem. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Andreas Roussos <a.roussos@dataly.gr> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=4877 Assignee|koha-bugs@lists.koha-commun |a.roussos@dataly.gr |ity.org | Status|NEW |ASSIGNED --- Comment #4 from Andreas Roussos <a.roussos@dataly.gr> --- I'm revisiting this as it's still valid in 22.05.02. Thanks to the comments posted at the following GitHub issue I believe I've found what's causing the broken man pages: https://github.com/docbook/xslt10-stylesheets/issues/123 The source XML files for our man pages have the following namespace declaration at the top: xmlns='http://docbook.org/ns/docbook'. That means they are DocBook V5.0 documents and should be processed by namespace-aware DocBook XSL stylesheets. However, the Stylesheet that generates the man pages from the DocBook XML source files is currently part of the docbook-xsl package. I think we should be using the Stylesheet from the docbook-xsl-ns package instead (I've actually tested this on Debian 9/10/11 and it worked just fine -- the generated man pages did not have any issues). -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 --- Comment #5 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- (In reply to Andreas Roussos from comment #4)
I'm revisiting this as it's still valid in 22.05.02.
Thanks to the comments posted at the following GitHub issue I believe I've found what's causing the broken man pages: https://github.com/docbook/xslt10-stylesheets/issues/123
The source XML files for our man pages have the following namespace declaration at the top: xmlns='http://docbook.org/ns/docbook'. That means they are DocBook V5.0 documents and should be processed by namespace-aware DocBook XSL stylesheets.
However, the Stylesheet that generates the man pages from the DocBook XML source files is currently part of the docbook-xsl package. I think we should be using the Stylesheet from the docbook-xsl-ns package instead (I've actually tested this on Debian 9/10/11 and it worked just fine -- the generated man pages did not have any issues).
I Andreas, I just ran into this issue testing bug 17379. Could you share a patch with your solution? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Andreas Roussos <a.roussos@dataly.gr> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |Needs Signoff Patch complexity|--- |Trivial patch -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 --- Comment #6 from Andreas Roussos <a.roussos@dataly.gr> --- Created attachment 141594 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=141594&action=edit Bug 27315: use the namespace-aware docbook stylesheet When viewing the man page for the `koha-list` command, the output does not appear correctly: there appears to be a "staircase"-like effect on the text. The same is true for all other man pages. The source XML files for our man pages have the following namespace declaration at the top: xmlns='http://docbook.org/ns/docbook', which means they are DocBook V5.0 documents and should be processed by namespace-aware DocBook XSL stylesheets. This patch fixes that by using the DocBook-to-man-page transformation stylesheet from the docbook-xsl-ns package (note the "-ns" suffix). Test plan: 1) Apply the patch 2) Build and install new package 3) Confirm the man pages display correctly -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 --- Comment #7 from Andreas Roussos <a.roussos@dataly.gr> --- (In reply to Katrin Fischer from comment #5)
I Andreas, I just ran into this issue testing bug 17379. Could you share a patch with your solution? Hi Katrin! Sorry for the delay in replying and for taking so long to prepare a patch for this bug report. I've now attached a patch, and wrote a simple test plan which will hopefully be adequate.
Please note: instead of replacing `docbook-xsl` in `debian/control.in` with `docbook-xsl-ns`, I opted for *adding* `docbook-xsl-ns` as an extra package in order to avoid any breakage that might occur in case someone was already using the non-namespace-aware variant. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 --- Comment #8 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Thanks a lot! I'll leave this for a moment in hope someone will sign-off to make this go into the QA queue :) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #141594|0 |1 is obsolete| | --- Comment #9 from David Nind <david@davidnind.com> --- Created attachment 141626 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=141626&action=edit Bug 27315: use the namespace-aware docbook stylesheet When viewing the man page for the `koha-list` command, the output does not appear correctly: there appears to be a "staircase"-like effect on the text. The same is true for all other man pages. The source XML files for our man pages have the following namespace declaration at the top: xmlns='http://docbook.org/ns/docbook', which means they are DocBook V5.0 documents and should be processed by namespace-aware DocBook XSL stylesheets. This patch fixes that by using the DocBook-to-man-page transformation stylesheet from the docbook-xsl-ns package (note the "-ns" suffix). Test plan: 1) Apply the patch 2) Build and install new package 3) Confirm the man pages display correctly Signed-off-by: David Nind <david@davidnind.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |david@davidnind.com --- Comment #10 from David Nind <david@davidnind.com> --- Testing notes (using koha-testing-docker): 1. To replicate the problem: (a) Install man-db: apt-get install man-db (b) man koha-list (or any package command) 2. I wasn't sure how to do step 2 in the test plan, so I: (a) applied the patch (b) installed dockbook-xsl-ns: apt-get install docbook-xsl-ns (c) xsltproc --output /tmp/koha-docs/ /usr/share/xml/docbook/stylesheet/docbook-xsl-ns/manpages/docbook.xsl /kohadevbox/koha/debian/docs/*.xml (d) change to the /tmp/koha-docs directory (e) man -l koha-list.8 (or any package command) (f) gzip -k * (-k = keep source xml files) (g) cp -R *.gz /usr/share/man/man8 (h) man koha-list (or any package command) * 3. Have signed off, as I'm assuming that the build process will now take care of correctly producing the man pages once the change is pushed to master. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact|testopia@bugs.koha-communit |katrin.fischer@bsz-bw.de |y.org | --- Comment #11 from Katrin Fischer <katrin.fischer@bsz-bw.de> ---
3. Have signed off, as I'm assuming that the build process will now take care of correctly producing the man pages once the change is pushed to master.
Thx for the notes and I'll hope the same :) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #141626|0 |1 is obsolete| | --- Comment #12 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 141930 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=141930&action=edit Bug 27315: use the namespace-aware docbook stylesheet When viewing the man page for the `koha-list` command, the output does not appear correctly: there appears to be a "staircase"-like effect on the text. The same is true for all other man pages. The source XML files for our man pages have the following namespace declaration at the top: xmlns='http://docbook.org/ns/docbook', which means they are DocBook V5.0 documents and should be processed by namespace-aware DocBook XSL stylesheets. This patch fixes that by using the DocBook-to-man-page transformation stylesheet from the docbook-xsl-ns package (note the "-ns" suffix). Test plan: 1) Apply the patch 2) Build and install new package 3) Confirm the man pages display correctly Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to master Version(s)| |22.11.00 released in| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 --- Comment #13 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Pushed to master for 22.11. Nice work everyone, thanks! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Lucas Gass <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lucas@bywatersolutions.com Status|Pushed to master |Pushed to stable Version(s)|22.11.00 |22.11.00, 22.05.08 released in| | --- Comment #14 from Lucas Gass <lucas@bywatersolutions.com> --- Backported to 22.05.x for upcoming 22.05.08 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 Arthur Suzuki <arthur.suzuki@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)|22.11.00, 22.05.08 |22.11.00, 22.05.08, released in| |21.11.15 CC| |arthur.suzuki@biblibre.com Status|Pushed to stable |Pushed to oldstable --- Comment #15 from Arthur Suzuki <arthur.suzuki@biblibre.com> --- applied to 21.11 for 21.11.15 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27315 wainuiwitikapark@catalyst.net.nz changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |wainuiwitikapark@catalyst.n | |et.nz --- Comment #16 from wainuiwitikapark@catalyst.net.nz --- Not backported to 21.05.x -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org