Arch Linux

Please read this before reporting a bug:
https://wiki.archlinux.org/title/Bug_reporting_guidelines

Do NOT report bugs when a package is just outdated, or it is in the AUR. Use the 'flag out of date' link on the package page, or the Mailing List.

REPEAT: Do NOT report bugs for outdated packages!
Tasklist

FS#73962 - 1) Why an empty dir? 2) What for insisting on doc.zip? 3) Few less chars to configure? 4) Build doc

Attached to Project: Arch Linux
Opened by regid (regid1) - Saturday, 26 February 2022, 00:28 GMT
Last edited by Andreas Radke (AndyRTR) - Saturday, 26 February 2022, 12:15 GMT
Task Type Bug Report
Category Packages: Extra
Status Closed
Assigned To Andreas Radke (AndyRTR)
Architecture All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

Description:
1) qpdf installs the empty directory /usr/share/doc/qpdf/. Should package_qpdf()

56c56
< rm -rf "${pkgdir}"/usr/share/doc/qpdf/README-doc.txt
---
> rm -rf "${pkgdir}"/usr/share/doc/qpdf

?
package_qpdf-docs() creates /usr/share/doc/qpdf/ directory anyway.
2) Even though the documentation is built from source, the source array requires
https://github.com/qpdf/qpdf/releases/download/release-${pkgname}-${pkgver}/${pkgname}-${pkgver}-doc.zip . What for? The notes at https://qpdf.readthedocs.io/en/stable/packaging.html#packaging-documentation looks to me relevant.
3) My experience is that --html-doc for configure is redundant since --enable-doc-maintenance is given. My understating is that https://github.com/qpdf/qpdf/blob/main/build-scripts/build-doc support my claim. It could be that I was confused in my experimentation.
4) The PKGBUILD has a comment about how to build the docs. It refers to https://github.com/qpdf/qpdf/blob/main/build-scripts/build-doc . Which is referred by https://qpdf.readthedocs.io/en/stable/installation.html#building-documentation as "for the qpdf distribution". https://github.com/qpdf/qpdf/blob/main/build-scripts/build-doc seems to build the doc.zip file. Is it relevant to arch packages? I think https://qpdf.readthedocs.io/en/stable/installation.html#building-documentation and https://qpdf.readthedocs.io/en/stable/packaging.html#packaging-documentation might have more information. My understanding is that the bottom paragraph of https://github.com/qpdf/qpdf/blob/main/README-doc.txt mentions these 2 URL. In addition, https://github.com/qpdf/qpdf refers to https://github.com/qpdf/qpdf/blob/main/build-scripts/build-doc as build-doc script. Isn't it Debian related? Perhaps the comment how to build the docs should be removed altogether? Or replaced by https://github.com/qpdf/qpdf/blob/main/README-doc.txt ?

Additional info:
* package version(s): 10.6.2-2
* config and/or log files etc.: (PKGBUILD)
* link to upstream bug report, if any: arch packaging related.

Steps to reproduce:
1) For 1st point above: Install the qpdf package (without the documentation package) and examine the content of /usr/share/doc/qpdf.
2) For the 2nd: Remove the doc.zip file prior to building the package and test the consequences.
3) 3rd point: Just try that.
4) 4th point: It is my understanding of https://github.com/qpdf/qpdf and https://qpdf.readthedocs.io . It could be I am wrong.
This task depends upon

Closed by  Andreas Radke (AndyRTR)
Saturday, 26 February 2022, 12:15 GMT
Reason for closing:  Fixed
Additional comments about closing:  10.6.2-3
Comment by Andreas Radke (AndyRTR) - Saturday, 26 February 2022, 12:15 GMT
It's pretty hard to read that report...

1) fixed
2) fixed (that was for trying why the old pkg had broken docs)
3) fixed
4) https://qpdf.readthedocs.io/en/stable/installation.html#building-documentation - points to working https://qpdf.readthedocs.io/en/stable/installation.html#building-documentation
- we just leave out the zipping and only ship the single_html docs. I'll keep that comment for reference in the PKGBUILD.

https://qpdf.readthedocs.io/en/stable/packaging.html#packaging-documentation is broken and cannot be used.

Loading...