linux-kernel - Re: [PATCH 00/11] Fix PDF doc builds on major distros

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250818114220.7f82d2f7@foz.lan>
Date: Mon, 18 Aug 2025 11:42:20 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Akira Yokosawa <akiyks@...il.com>
Cc: corbet@....net, linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 00/11] Fix PDF doc builds on major distros

Em Mon, 18 Aug 2025 09:44:39 +0900
Akira Yokosawa <akiyks@...il.com> escreveu:

> On Mon, 18 Aug 2025 01:07:24 +0900, Akira Yokosawa wrote:
> [...]
> 
> > 
> > Ah, I have finally understood what 5/11 is trying to do.
> > 
> > Its changelog mainly talks about an issue you saw after adding options
> > to xindy in that same commit, and you added
> > 
> >    \newfontfamily\headingfont{DejaVu Serif}
> > 
> > to resolve it.  
> 
> Sidenote:
> 
> It looks like texlive-xindy is not available for RHEL based distros.

On several rpm-based distros, extra repositories are needed.

So, if you take a look at rpmfind:
	https://rpmfind.net/linux/rpm2html/search.php?query=python3-sphinx

For the limited set of distros supported there, you'll see that sphinx-build
can either be at:
	- main distro repos;
	- CRB;
	- Powertools

But this is only a fraction of the problem, as there are several
exceptions. For instance, RHEL8 from "redhat/ubi8" docker container(*) 
sounds to be an official vendor-provided image.

(*) https://hub.docker.com/r/redhat/ubi8

Yet, if you use it and try to install sphinx-build:

	# dnf install python3-sphinx
	Updating Subscription Management repositories.
	Unable to read consumer identity

	This system is not registered with an entitlement server. You can use subscription-manager to register.

	Last metadata expiration check: 21:10:22 ago on Sun Aug 17 11:30:23 2025.
	No match for argument: python3-sphinx
	Error: Unable to find a match: python3-sphinx

It won't work, because repo management in this case requires to setup
a paywall protected procedure.

> That means, you will need to ask EPEL to provide it.
> Otherwise, you are obsoleting those distros for pdfdocs build
> (under the confinement of "distro packages only").

Recommending a repository setup for rpm distros is complex. When
I wrote sphinx-pre-install, I opted to keep such setup out of it.

The rationale is that the ones using such distros should know
better and may require a paid subscription.

With the exception of rpmfusion on Fedora, where one needs to first
download a RPM file from some site, for most distros, the extra
needed repositories are already installed or can be installed from
a package provided at the main repository. Once downloaded,
all it takes is to enable it. 

For instance, to get what is needed to build both html and pdf on 
RockyLinux, one needs to install a distro package:

	dnf install -y epel-release

Which adds extra repositories to /etc/yum.repos.d/.

Then, either use config-manager:

	# change "enable" flag from /etc/yum.repos.d/ repos
	dnf install 'dnf-command(config-manager)'
	dnf config-manager --set-enabled powertools appstream epel

or pass an extra option to enable the repo(s) during install:

	sudo dnf --enablrepo=powertools --enablrepo=appstream --enablrepo=epel install -y python3-sphinx {other packages}

Now, sphinx-pre-install can later be improved to also contain
repo-management instructions but this is out of the scope of this
series (and I'm not sure if it is worth adding it there).

Thanks,
Mauro