FS#55500 - [linux] Documentation uses sphinx, drop xmlto and docbook makedepends

Attached to Project: Arch Linux
Opened by Vorbote (vorbote) - Monday, 04 September 2017, 13:38 GMT
Last edited by Jan Alexander Steffens (heftig) - Sunday, 28 May 2023, 18:05 GMT
Task Type Bug Report
Category Packages: Core
Status Closed
Assigned To Tobias Powalowski (tpowa)
Jan Alexander Steffens (heftig)
Architecture All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 1
Private No

Details

Since version 4.8, linux transitioned all documentation from DocBook XML to sphinx[1,2,3,4]. xmlto and docbook-xml makedepends should be replaced by python-sphinx and python-sphinx_rtd_theme or dropped altogether.


[1] https://lwn.net/Articles/692704/

[2] https://lwn.net/Articles/692705/

[3] http://kernel.readthedocs.io/en/latest/kernel-documentation.html

[4] http://kernel.readthedocs.io/en/latest/kernel-documentation.html#docbook-xml-deprecated
This task depends upon

Closed by  Jan Alexander Steffens (heftig)
Sunday, 28 May 2023, 18:05 GMT
Reason for closing:  Fixed
Additional comments about closing:  Fixed in main, pending next release.
Comment by loqs (loqs) - Thursday, 07 September 2017, 13:15 GMT
This also breaks the commit "Prepare 4.13" https://git.archlinux.org/svntogit/packages.git/tree/trunk/PKGBUILD?h=packages/linux&id=7648ebf0fa9b0190aa26a11acd46ac31f0593b69#n182
4.13 Does not contain a directory Documentation/DocBook
Comment by loqs (loqs) - Monday, 07 September 2020, 12:44 GMT
docbook use was dropped in linux 4.13-1 [1]. sphinx use was added in linux 4.18.4.arch1-1  FS#59688  [2].
xmlto is still in makedepends. It appears to only be needed to build the tools subdirectory which is split to the linux-tools package.

[1] https://github.com/archlinux/svntogit-packages/commit/8aac57c7afd7332f269a1fc869f49e2463056638
[2] https://github.com/archlinux/svntogit-packages/commit/c3b5e10f9b704742e282a03803482c81e75dee5f
Comment by Toolybird (Toolybird) - Sunday, 28 May 2023, 06:11 GMT
This is a very old ticket. xmlto is still in makedeps. Is it actually needed or can it be punted?
Comment by loqs (loqs) - Sunday, 28 May 2023, 15:03 GMT
I removed it and it made no noticeable difference to the generated documentation. I say noticeable difference as linux-docs is not reproducible (possibly a race issue?) as tracked by reproducible builds effort but those changes occur independent of the presence/absence of xmlto. xmlto is still present in the linux kernel source and used to for example generate the man pages for perf from the linux-tools PKGBUILD.

Loading...