make pdfdocs fails on Debian stable

Hi Jon and Mauro,

when trying to do a make pdfdocs on my Debian stable system I can't get it to complete. The output below is from linux-next, but mainline is the same.

------------
Running 'xelatex --no-pdf -interaction=batchmode -no-pdf -recorder "RCU.tex"'
------------
This is XeTeX, Version 3.14159265-2.6-0.999992 (TeX Live 2020/Debian) (preloaded format=xelatex) restricted \write18 enabled.
entering extended mode
Latexmk: Examining 'RCU.log'
=== TeX engine is 'XeTeX'
Latexmk: Index file 'RCU.idx' was written
Latexmk: References changed.
Latexmk: Log file says output to 'RCU.xdv'
Latexmk: Errors, so I did not complete making targets

Collected error summary (may duplicate other messages):
xelatex: Command for 'xelatex' gave return code 1
Refer to 'RCU.log' for details
Latexmk: Use the -f option to force complete processing,
unless error was exceeding maximum runs, or warnings treated as errors.
make[2]: *** [Makefile:29: RCU.pdf] Error 12
make[1]: *** [Documentation/Makefile:115: pdfdocs] Error 2
make: *** [Makefile:1772: pdfdocs] Error 2

Weird... when you do a make, it should have checked for all dependencies, when it internally runs:

./scripts/sphinx-pre-install

Basically, you need the xelatex package for it to work, as PDF output is via LaTeX. This is not a mandatory requirement, though, as most people are only interested on html output, and LaTeX dependencies require to install lots of stuff. it should provide you a list of packages required for PDF, with a suggestion of using apt-get to install it.

In this specific case, I guess the package name is 'texlive-xetex'.

Quoted 4 lines

Weird... when you do a make, it should have checked for all dependencies, when it internally runs:

./scripts/sphinx-pre-install

Detected OS: Debian GNU/Linux 11 (bullseye).
Sphinx version: 3.4.3

All optional dependencies are met.
Needed package dependencies are met.

Quoted 7 lines

Basically, you need the xelatex package for it to work, as PDF output is via LaTeX. This is not a mandatory requirement, though, as most people are only interested on html output, and LaTeX dependencies require to install lots of stuff. it should provide you a list of packages required for PDF, with a suggestion of using apt-get to install it.

Quoted 1 line

In this specific case, I guess the package name is 'texlive-xetex'.

texlive-xetex is installed and seems to work find on various other documents produced earlier by make pdfdocs

After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output.

Reported-by Christoph Hellwig <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

See [PATCH 0/1] at: https://lore.kernel.org/all/[email protected]/

 scripts/sphinx-pre-install | 1 +
 1 file changed, 1 insertion(+)

scripts/sphinx-pre-install +0 -0

index 288e86a9d1e5..46aaab414098 100755

Quoted 3 lines · Mauro Carvalho Chehab

After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output.

Quoted 15 lines

Reported-by Christoph Hellwig <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

See [PATCH 0/1] at: https://lore.kernel.org/all/[email protected]/

 scripts/sphinx-pre-install | 1 +
 1 file changed, 1 insertion(+)

scripts/sphinx-pre-install +0 -0

index 288e86a9d1e5..46aaab414098 100755

scripts/sphinx-pre-install my %texlive = ( · line 82

Quoted 5 lines

scripts/sphinx-pre-install +1 -0

@@ -78,6 +78,7 @@ my %texlive = (
 	'ucs.sty'            => 'texlive-ucs',
 	'upquote.sty'        => 'texlive-upquote',
 	'wrapfig.sty'        => 'texlive-wrapfig',
+	'ctexhook.sty'       => 'texlive-ctex',
 );

I've applied this, thanks.>
jon

Hi,

Quoted 2 lines · Jonathan Corbet

Mauro Carvalho Chehab <[email protected]> writes:

Quoted 3 lines

Quoted 3 lines

After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output.

FWIW, ctexhook.sty is a new requirement of xeCJK.sty v3.8.7 released in June 2021.

Thanks, Akira

Quoted 21 lines

Quoted 20 lines

Reported-by Christoph Hellwig <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

See [PATCH 0/1] at: https://lore.kernel.org/all/[email protected]/

 scripts/sphinx-pre-install | 1 +
 1 file changed, 1 insertion(+)

scripts/sphinx-pre-install +1 -0

index 288e86a9d1e5..46aaab414098 100755
@@ -78,6 +78,7 @@ my %texlive = (
 	'ucs.sty'            => 'texlive-ucs',
 	'upquote.sty'        => 'texlive-upquote',
 	'wrapfig.sty'        => 'texlive-wrapfig',
+	'ctexhook.sty'       => 'texlive-ctex',
 );

Quoted 2 lines

I've applied this, thanks.>
jon

Hi Mauro, see inline comments below.

Quoted 5 lines · Akira Yokosawa

Hi,

Quoted 2 lines · Jonathan Corbet

Mauro Carvalho Chehab <[email protected]> writes:

Quoted 30 lines

Quoted 3 lines

Quoted 3 lines

After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output.

FWIW, ctexhook.sty is a new requirement of xeCJK.sty v3.8.7 released in June 2021.

Thanks, Akira

Quoted 21 lines

Quoted 20 lines

Reported-by Christoph Hellwig <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

See [PATCH 0/1] at: https://lore.kernel.org/all/[email protected]/

 scripts/sphinx-pre-install | 1 +
 1 file changed, 1 insertion(+)

scripts/sphinx-pre-install +1 -0

index 288e86a9d1e5..46aaab414098 100755
@@ -78,6 +78,7 @@ my %texlive = (
 	'ucs.sty'            => 'texlive-ucs',
 	'upquote.sty'        => 'texlive-upquote',
 	'wrapfig.sty'        => 'texlive-wrapfig',
+	'ctexhook.sty'       => 'texlive-ctex',
 );  

I'm afraid this update of the list for Fedora/openSUSE won't help Debian Stable (bullseye) users.

ctexhook.sty is in texlive-lang-chinese on Debian/Ubuntu.

Em Tue, 4 Jan 2022 10:54:52 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 39 lines

Hi Mauro, see inline comments below.

Quoted 35 lines · Akira Yokosawa

Hi,

Quoted 5 lines · Jonathan Corbet

Quoted 3 lines · Mauro Carvalho Chehab

After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output.

FWIW, ctexhook.sty is a new requirement of xeCJK.sty v3.8.7 released in June 2021.

Thanks, Akira

Quoted 21 lines

Quoted 20 lines

Reported-by Christoph Hellwig <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

See [PATCH 0/1] at: https://lore.kernel.org/all/[email protected]/

 scripts/sphinx-pre-install | 1 +
 1 file changed, 1 insertion(+)

scripts/sphinx-pre-install +1 -0

index 288e86a9d1e5..46aaab414098 100755
@@ -78,6 +78,7 @@ my %texlive = (
 	'ucs.sty'            => 'texlive-ucs',
 	'upquote.sty'        => 'texlive-upquote',
 	'wrapfig.sty'        => 'texlive-wrapfig',
+	'ctexhook.sty'       => 'texlive-ctex',
 );  

Quoted 4 lines

I'm afraid this update of the list for Fedora/openSUSE won't help Debian Stable (bullseye) users.

ctexhook.sty is in texlive-lang-chinese on Debian/Ubuntu.

On such case, it is needed to map it for Debian/Ubuntu. Could you please test the enclosed patch, applied on the top of the previous one?

Thanks!
Mauro

-

[PATCH] scripts: sphinx-pre-install: Fix ctex support on Debian

The name of the package with ctexhook.sty is different on Debian/Ubuntu.

Reported-by Akira Yokosawa <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

scripts/sphinx-pre-install +0 -0

index 46aaab414098..ea96d18ee946 100755

Quoted 42 lines

Em Tue, 4 Jan 2022 10:54:52 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 39 lines

Hi Mauro, see inline comments below.

Quoted 35 lines · Akira Yokosawa

Hi,

Quoted 5 lines · Jonathan Corbet

Quoted 3 lines · Mauro Carvalho Chehab

After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output.

FWIW, ctexhook.sty is a new requirement of xeCJK.sty v3.8.7 released in June 2021.

Thanks, Akira

Quoted 21 lines

Quoted 20 lines

Reported-by Christoph Hellwig <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

See [PATCH 0/1] at: https://lore.kernel.org/all/[email protected]/

 scripts/sphinx-pre-install | 1 +
 1 file changed, 1 insertion(+)

scripts/sphinx-pre-install +1 -0

index 288e86a9d1e5..46aaab414098 100755
@@ -78,6 +78,7 @@ my %texlive = (
 	'ucs.sty'            => 'texlive-ucs',
 	'upquote.sty'        => 'texlive-upquote',
 	'wrapfig.sty'        => 'texlive-wrapfig',
+	'ctexhook.sty'       => 'texlive-ctex',
 );    

Quoted 8 lines

Quoted 4 lines

I'm afraid this update of the list for Fedora/openSUSE won't help Debian Stable (bullseye) users.

ctexhook.sty is in texlive-lang-chinese on Debian/Ubuntu.

On such case, it is needed to map it for Debian/Ubuntu. Could you please test the enclosed patch, applied on the top of the previous one?

Looks like we need an additional hunk. See below.

Thanks, Akira

Quoted 27 lines

Thanks!
Mauro

-

[PATCH] scripts: sphinx-pre-install: Fix ctex support on Debian

The name of the package with ctexhook.sty is different on Debian/Ubuntu.

Reported-by Akira Yokosawa <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

scripts/sphinx-pre-install +1 -0

index 46aaab414098..ea96d18ee946 100755
@@ -367,6 +367,7 @@ sub give_debian_hints()
 		"Pod::Usage"		=> "perl-modules",
 		"xelatex"		=> "texlive-xetex",
 		"rsvg-convert"		=> "librsvg2-bin",
+		"texlive-ctex"		=> "texlive-lang-chinese",
 	);
 
 	if ($pdf) {

Em Tue, 4 Jan 2022 19:26:10 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 90 lines · Mauro Carvalho Chehab

Quoted 42 lines

Em Tue, 4 Jan 2022 10:54:52 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 39 lines

Hi Mauro, see inline comments below.

Quoted 35 lines · Akira Yokosawa

Hi,

Quoted 5 lines · Jonathan Corbet

Quoted 3 lines · Mauro Carvalho Chehab

After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output.

FWIW, ctexhook.sty is a new requirement of xeCJK.sty v3.8.7 released in June 2021.

Thanks, Akira

Quoted 21 lines

Quoted 20 lines

Reported-by Christoph Hellwig <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

See [PATCH 0/1] at: https://lore.kernel.org/all/[email protected]/

 scripts/sphinx-pre-install | 1 +
 1 file changed, 1 insertion(+)

scripts/sphinx-pre-install +1 -0

index 288e86a9d1e5..46aaab414098 100755
@@ -78,6 +78,7 @@ my %texlive = (
 	'ucs.sty'            => 'texlive-ucs',
 	'upquote.sty'        => 'texlive-upquote',
 	'wrapfig.sty'        => 'texlive-wrapfig',
+	'ctexhook.sty'       => 'texlive-ctex',
 );    

Quoted 8 lines

Quoted 4 lines

I'm afraid this update of the list for Fedora/openSUSE won't help Debian Stable (bullseye) users.

ctexhook.sty is in texlive-lang-chinese on Debian/Ubuntu.

On such case, it is needed to map it for Debian/Ubuntu. Could you please test the enclosed patch, applied on the top of the previous one?

Looks like we need an additional hunk. See below.

Thanks, Akira

Quoted 27 lines

Thanks!
Mauro

-

[PATCH] scripts: sphinx-pre-install: Fix ctex support on Debian

The name of the package with ctexhook.sty is different on Debian/Ubuntu.

Reported-by Akira Yokosawa <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

scripts/sphinx-pre-install +1 -0

index 46aaab414098..ea96d18ee946 100755
@@ -367,6 +367,7 @@ sub give_debian_hints()
 		"Pod::Usage"		=> "perl-modules",
 		"xelatex"		=> "texlive-xetex",
 		"rsvg-convert"		=> "librsvg2-bin",
+		"texlive-ctex"		=> "texlive-lang-chinese",
 	);
 
 	if ($pdf) {

scripts/sphinx-pre-install +1 -0

@@ -380,6 +381,7 @@ sub give_debian_hints()
        }
 
        check_program("dvipng", 2) if ($pdf);
+       check_missing_tex(2) if ($pdf);
        check_missing(\%map);
 

Review sub give_debian_hints() · line 387

Quoted 2 lines

(quoted diff) +0 -0

        return if (!$need && !$optional);

This would be more complex than that, and per-distro tests are required, in order to avoid the script to fail on other distros.

Something like the following (possibly incomplete) patch.

Thanks,
Mauro

[PATCH RFC] scripts: sphinx-pre-install: better handle pdf dependencies

Not all distro hints check for missing LaTeX dependencies. So add a call for it for check_missing_tex() to all distros.

While here, change the parameters to pass the map hash, as distro-specific mapping could be needed.

Reported-by Akira Yokosawa <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

scripts/sphinx-pre-install +11 -5

index ea96d18ee946..03c252590e54 100755
@@ -227,7 +227,8 @@ sub check_pacman_missing($$)
 
 sub check_missing_tex($)
 {
-	my $is_optional = shift;
+	my $map = %{$_[0]};
+	my $is_optional = 2;
 	my $kpsewhich = findprog("kpsewhich");
 
 	foreach my $prog(keys %texlive) {

@@ -381,6 +382,7 @@ sub give_debian_hints()
 	}
 
 	check_program("dvipng", 2) if ($pdf);
+	check_missing_tex(\%map) if ($pdf);
 	check_missing(\%map);
 
 	return if (!$need && !$optional);

@@ -449,7 +451,7 @@ sub give_redhat_hints()
 
 	check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old);
 	check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf);
-	check_missing_tex(2) if ($pdf);
+	check_missing_tex(\%map) if ($pdf);
 	check_missing(\%map);
 
 	return if (!$need && !$optional);

@@ -503,7 +505,7 @@ sub give_opensuse_hints()
 	# "Noto Sans CJK SC" on openSUSE
 
 	check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf);
-	check_missing_tex(2) if ($pdf);
+	check_missing_tex(\%map) if ($pdf);
 	check_missing(\%map);
 
 	return if (!$need && !$optional);

@@ -548,6 +550,7 @@ sub give_mageia_hints()
 	}
 
 	check_rpm_missing(\@tex_pkgs, 2) if ($pdf);
+	# check_missing_tex(\%map) if ($pdf);
 	check_missing(\%map);
 
 	return if (!$need && !$optional);

@@ -578,6 +581,7 @@ sub give_arch_linux_hints()
 				   "noto-fonts-cjk", 2);
 	}
 
+	check_missing_tex(\%map) if ($pdf);
 	check_missing(\%map);
 
 	return if (!$need && !$optional);

@@ -604,6 +608,8 @@ sub give_gentoo_hints()
 				   "media-fonts/noto-cjk", 2);
 	}
 
+	# Gentoo doesn't need to map tex, as there's a single package,
+	# and extra fonts are mapped via check_missing_file()
 	check_missing(\%map);
 
 	return if (!$need && !$optional);

@@ -622,7 +628,7 @@ sub give_gentoo_hints()
 		printf("\tsudo su -c 'echo \"$cairo\" > $portage_cairo'\n");
 	}
 
-	printf("\tsudo emerge --ask $install\n");
+	printf("\tsudo USE="-cjk" emerge --ask $install\n");
 
 }
 

@@ -685,7 +691,7 @@ sub check_distros()
 	my %map = (
 		"sphinx-build" => "sphinx"
 	);
-	check_missing_tex(2) if ($pdf);
+	check_missing_tex(\%map) if ($pdf);
 	check_missing(\%map);
 	print "I don't know distro $system_release.\n";
 	print "So, I can't provide you a hint with the install procedure.\n";

Quoted 93 lines

Em Tue, 4 Jan 2022 19:26:10 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 90 lines · Mauro Carvalho Chehab

Quoted 42 lines

Em Tue, 4 Jan 2022 10:54:52 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 39 lines

Hi Mauro, see inline comments below.

Quoted 35 lines · Akira Yokosawa

Hi,

Quoted 5 lines · Jonathan Corbet

Quoted 3 lines · Mauro Carvalho Chehab

After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output.

FWIW, ctexhook.sty is a new requirement of xeCJK.sty v3.8.7 released in June 2021.

Thanks, Akira

Quoted 21 lines

Quoted 20 lines

Reported-by Christoph Hellwig <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

See [PATCH 0/1] at: https://lore.kernel.org/all/[email protected]/

 scripts/sphinx-pre-install | 1 +
 1 file changed, 1 insertion(+)

scripts/sphinx-pre-install +1 -0

index 288e86a9d1e5..46aaab414098 100755
@@ -78,6 +78,7 @@ my %texlive = (
 	'ucs.sty'            => 'texlive-ucs',
 	'upquote.sty'        => 'texlive-upquote',
 	'wrapfig.sty'        => 'texlive-wrapfig',
+	'ctexhook.sty'       => 'texlive-ctex',
 );    

Quoted 8 lines

Quoted 4 lines

I'm afraid this update of the list for Fedora/openSUSE won't help Debian Stable (bullseye) users.

ctexhook.sty is in texlive-lang-chinese on Debian/Ubuntu.

On such case, it is needed to map it for Debian/Ubuntu. Could you please test the enclosed patch, applied on the top of the previous one?

Looks like we need an additional hunk. See below.

Thanks, Akira

Quoted 27 lines

Thanks!
Mauro

-

[PATCH] scripts: sphinx-pre-install: Fix ctex support on Debian

The name of the package with ctexhook.sty is different on Debian/Ubuntu.

Reported-by Akira Yokosawa <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

scripts/sphinx-pre-install +1 -0

index 46aaab414098..ea96d18ee946 100755
@@ -367,6 +367,7 @@ sub give_debian_hints()
 		"Pod::Usage"		=> "perl-modules",
 		"xelatex"		=> "texlive-xetex",
 		"rsvg-convert"		=> "librsvg2-bin",
+		"texlive-ctex"		=> "texlive-lang-chinese",
 	);
 
 	if ($pdf) {

scripts/sphinx-pre-install +1 -0

@@ -380,6 +381,7 @@ sub give_debian_hints()
        }
 
        check_program("dvipng", 2) if ($pdf);
+       check_missing_tex(2) if ($pdf);
        check_missing(\%map);
 

Quoted 6 lines

Review sub give_debian_hints() · line 387

Quoted 2 lines

(quoted diff) +0 -0

        return if (!$need && !$optional);

This would be more complex than that, and per-distro tests are required, in order to avoid the script to fail on other distros.

Thank you for looking into this!
I must admit I'm far from grasping how this perl script works...

Quoted 2 lines

Something like the following (possibly incomplete) patch.

I'll test it under various distros/setups.
It may take a while.

Em Wed, 5 Jan 2022 21:09:59 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 3 lines

I'll test it under various distros/setups.
It may take a while.

Did a quick test here with this lxc container:

	$ OS=debian REL=bullseye ;lxc-create -n ${OS} -t /usr/share/lxc/templates/lxc-download -- --dist ${OS} --release ${REL} --arch amd64

If we add check_missing_tex(), it will then complain about lots of packages that don't exist in Debian (se logs at the end).

That's one of the biggest issue with texlive: each distro splits it on different ways. So, basically, the %texlive hash at the script is meant to the way Fedora and openSuse distros usually map packages. I would expect that Mageia would also be similar if not identical, but other distros map packages on different ways.

I'll prepare another patch for fixing the debian issue.

Regards,
Mauro

---

mchehab@debian:~/docs$ make pdfdocs
Documentation/Makefile:41: The 'sphinx-build' command was not found. Make sure you have Sphinx installed and in PATH, or set the SPHINXBUILD make variable to point to the full path of the 'sphinx-build' executable.

Detected OS: Debian GNU/Linux 11.
Warning: better to also install "convert".
Warning: better to also install "dot".
Warning: better to also install "dvipng".
Warning: better to also install "fonts-dejavu".
Warning: better to also install "fonts-noto-cjk".
ERROR: please install "gcc", otherwise, build won't work.
Warning: better to also install "latexmk".
ERROR: please install "python", otherwise, build won't work.
Warning: better to also install "rsvg-convert".
Warning: better to also install "texlive-amscls".
Warning: better to also install "texlive-amsfonts".
Warning: better to also install "texlive-amsmath".
Warning: better to also install "texlive-anyfontsize".
Warning: better to also install "texlive-capt-of".
Warning: better to also install "texlive-cmap".
Warning: better to also install "texlive-ctex".

The name of the package with ctexhook.sty is different on Debian/Ubuntu.

Reported-by Akira Yokosawa <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 scripts/sphinx-pre-install | 3 +++
 1 file changed, 3 insertions(+)

scripts/sphinx-pre-install +3 -0

index 46aaab414098..f126ecbb0494 100755
@@ -370,6 +370,9 @@ sub give_debian_hints()
 	);
 
 	if ($pdf) {
+		check_missing_file(["/usr/share/texlive/texmf-dist/tex/latex/ctex/ctexhook.sty"],
+				   "texlive-lang-chinese", 2);
+
 		check_missing_file(["/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf"],
 				   "fonts-dejavu", 2);
 

Signature · 1 line

2.33.1

Em Thu, 6 Jan 2022 11:00:08 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 2 lines

Longer term (for CentOS stream9 or RHEL 9), we might need to ask EPEL maintainers to add texlive-ctex.

Longer term, the script is actually fixing a broken dependency issue on distros. So, bugzillas for Fedora/Debian & derivated ones should be opened for "texlive-xecjk" package to also select "texlive-ctex" (or whatever other name those packages have on distros).

Worth mentioning that the script dependency-checking is should be smart enough to not break once texlive distro maintainers fix such issues.

Thanks,
Mauro

Hi Maruo,
(+Cc: Jon, linux-doc)

Quoted 2 lines · Mauro Carvalho Chehab

Em Thu, 6 Jan 2022 11:00:08 +0900
Akira Yokosawa <[email protected]> escreveu:

[...]

Quoted 3 lines

Quoted 2 lines

Longer term (for CentOS stream9 or RHEL 9), we might need to ask EPEL maintainers to add texlive-ctex.

Quoted 4 lines

Longer term, the script is actually fixing a broken dependency issue on distros. So, bugzillas for Fedora/Debian & derivated ones should be opened for "texlive-xecjk" package to also select "texlive-ctex" (or whatever other name those packages have on distros).

FWIW, I asked Karl Berry, who is the chief maintainer of upstream TeX Live, to add a dependency on ctex to xecjk [1].

[1]: https://tug.org/pipermail/tex-live/2022-January/047648.html

Karl has added the dependency to xecjk as of rev 61529 [2].

[2]: https://tug.org/pipermail/tex-live/2022-January/047654.html

On up-to-date vanilla TeX Live 2021 (>= rev61529):

    $ tlmgr info --data depends xecjk
    ctex

With xecjk < rev61529

    $ tlmgr info --data depends xecjk
    (no output)

This dependency is expected to be reflected in the TeX Live packaging for next Fedora release.

OTOH, as I mentioned earlier,
EPEL 9 (for CentOS stream9) doesn't have texlive-ctex at the moment, so we need to see what happens there when RHEL 9 is ready.

Note: the xecjk -> ctex dependency is already taken care of by openSUSE's TeX Live packages.

As for Ubuntu/Debian, it looks like TeX Live/Debian packaging maintainer, Norbert Preining, has no intention of adding dependency of texlive-xetex -> texlive-lang-chinese as can be seen in his responses to a Debian Bug report [3].
I think this is a reasonable choice as most xetex users don't use xecjk and texlive-lang-chinese is large in size.

[3]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=961703

Thanks, Akira

Quoted 7 lines

Worth mentioning that the script dependency-checking is should be smart enough to not break once texlive distro maintainers fix such issues.

Thanks,
Mauro

Em Sun, 9 Jan 2022 13:09:19 +0900
Akira Yokosawa <[email protected]> escreveu:

Quoted 10 lines

Hi Maruo,
(+Cc: Jon, linux-doc)

Quoted 2 lines · Mauro Carvalho Chehab

Em Thu, 6 Jan 2022 11:00:08 +0900
Akira Yokosawa <[email protected]> escreveu:

[...]

Quoted 3 lines

Quoted 2 lines

Longer term (for CentOS stream9 or RHEL 9), we might need to ask EPEL maintainers to add texlive-ctex.

Quoted 7 lines

Quoted 4 lines

Longer term, the script is actually fixing a broken dependency issue on distros. So, bugzillas for Fedora/Debian & derivated ones should be opened for "texlive-xecjk" package to also select "texlive-ctex" (or whatever other name those packages have on distros).

FWIW, I asked Karl Berry, who is the chief maintainer of upstream TeX Live, to add a dependency on ctex to xecjk [1].

Thanks for forwarding this question to him and to address it on distros!

Quoted 9 lines

[1]: https://tug.org/pipermail/tex-live/2022-January/047648.html

Karl has added the dependency to xecjk as of rev 61529 [2].

[2]: https://tug.org/pipermail/tex-live/2022-January/047654.html

On up-to-date vanilla TeX Live 2021 (>= rev61529):

Quoted 7 lines

    $ tlmgr info --data depends xecjk
    ctex

With xecjk < rev61529

    $ tlmgr info --data depends xecjk
    (no output)

Nice! Yeah, this is the long term solution, but still won't prevent people/distros based on older packages to keep using packages without such requirements.

Quoted 2 lines

This dependency is expected to be reflected in the TeX Live packaging for next Fedora release.

Yeah, Fedora is usually keen to changes.

Quoted 3 lines

OTOH, as I mentioned earlier,
EPEL 9 (for CentOS stream9) doesn't have texlive-ctex at the moment, so we need to see what happens there when RHEL 9 is ready.

Yes. RHEL/EPEL is usually a lot more conservative.

Quoted 2 lines

Note: the xecjk -> ctex dependency is already taken care of by openSUSE's TeX Live packages.

On both Tumbleweed and on Leap?

Quoted 9 lines

As for Ubuntu/Debian, it looks like TeX Live/Debian packaging maintainer, Norbert Preining, has no intention of adding dependency of texlive-xetex -> texlive-lang-chinese as can be seen in his responses to a Debian Bug report [3].
I think this is a reasonable choice as most xetex users don't use xecjk and texlive-lang-chinese is large in size.

[3]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=961703

Debian package maintainer could reconsider it after the upstream dependency addition, but probably only for SID and yet-to-be-released versions.
Debian is very conservative on their releases.
Even if SID gains such dependency fix, I would be surprised if they end porting a dependency change like that to Bullseye (which should be the latest version for ~1.5 years - with LTS extending it for ~3.5 years).

It sounds worth mentioning about the texlive dependency decision at the Debian bug.

Quoted 10 lines

Thanks, Akira

Quoted 7 lines

Worth mentioning that the script dependency-checking is should be smart enough to not break once texlive distro maintainers fix such issues.

Thanks,
Mauro

The name of the package with ctexhook.sty is different on Debian/Ubuntu.

Reported-by Akira Yokosawa <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 scripts/sphinx-pre-install | 3 +++
 1 file changed, 3 insertions(+)

Quoted 3 lines

Em Wed, 5 Jan 2022 21:09:59 +0900
Akira Yokosawa <[email protected]> escreveu:

[...]

Quoted 10 lines

Quoted 3 lines

I'll test it under various distros/setups.
It may take a while.

Did a quick test here with this lxc container:

	$ OS=debian REL=bullseye ;lxc-create -n ${OS} -t /usr/share/lxc/templates/lxc-download -- --dist ${OS} --release ${REL} --arch amd64

If we add check_missing_tex(), it will then complain about lots of packages that don't exist in Debian (se logs at the end).

Now I think I understand what kind of tests we need.

My plan was to intentionally uninstall texlive-ctex (or whichever package contains ctexhook.sty) and see if the lack of ctexhook.sty is detected or not.

Apparently, such a test would mean little for sphinx_pre_install.

Quoted 7 lines

That's one of the biggest issue with texlive: each distro splits it on different ways. So, basically, the %texlive hash at the script is meant to the way Fedora and openSuse distros usually map packages. I would expect that Mageia would also be similar if not identical, but other distros map packages on different ways.

I'll prepare another patch for fixing the debian issue.

Then I'll wait for it.

Hi,

Quoted 5 lines · Jonathan Corbet

Quoted 3 lines · Mauro Carvalho Chehab

After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output.

FWIW, ctexhook.sty is a new requirement of xeCJK.sty v3.8.7 released in June 2021.

Thanks, Akira

Quoted 23 lines

Quoted 15 lines

Reported-by Christoph Hellwig <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---

See [PATCH 0/1] at: https://lore.kernel.org/all/[email protected]/

 scripts/sphinx-pre-install | 1 +
 1 file changed, 1 insertion(+)

scripts/sphinx-pre-install +0 -0

index 288e86a9d1e5..46aaab414098 100755

scripts/sphinx-pre-install my %texlive = ( · line 82

Quoted 5 lines

scripts/sphinx-pre-install +1 -0

@@ -78,6 +78,7 @@ my %texlive = (
 	'ucs.sty'            => 'texlive-ucs',
 	'upquote.sty'        => 'texlive-upquote',
 	'wrapfig.sty'        => 'texlive-wrapfig',
+	'ctexhook.sty'       => 'texlive-ctex',
 );

I've applied this, thanks.>
jon

Ah, the error is specific to RCU.tex then?

You'll need to re-run xelatex with -interaction=interactive, in order to be able to identify what's the root cause.

You could do this by using LATEXOPTS, e. g.:

	$ make SPHINXDIRS=RCU LATEXOPTS="-interaction=interactive" pdfdocs

With that, LaTeX will stop at the offending line from the .tex file.

On a quick test here, I'm getting these at Fedora 35:

(/usr/share/texlive/texmf-dist/tex/latex/l3packages/xtemplate/xtemplate.sty)

! LaTeX Error: File `ctexhook.sty' not found.

Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: sty)

It seems that a recent change (probably to better address issues with Chinese and Japanese translation) added an extra dependency to some stylesheet.

I solved it by installing this package: "texlive-ctex".

Quoted 1 line · Mauro Carvalho Chehab

Ah, the error is specific to RCU.tex then?

Yes.

Quoted 16 lines

You'll need to re-run xelatex with -interaction=interactive, in order to be able to identify what's the root cause.

You could do this by using LATEXOPTS, e. g.:

	$ make SPHINXDIRS=RCU LATEXOPTS="-interaction=interactive" pdfdocs

With that, LaTeX will stop at the offending line from the .tex file.

On a quick test here, I'm getting these at Fedora 35:

(/usr/share/texlive/texmf-dist/tex/latex/l3packages/xtemplate/xtemplate.sty)

! LaTeX Error: File `ctexhook.sty' not found.

Quoted 8 lines

Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: sty)

It seems that a recent change (probably to better address issues with Chinese and Japanese translation) added an extra dependency to some stylesheet.

I solved it by installing this package: "texlive-ctex".

There is no texlive-ctex on Debian, but ctexhook.sty is installed as part of texlive-extra-utils. Here are the last lines from the interactive run:

(/usr/share/texlive/texmf-dist/tex/latex/ctex/ctexhook.sty) (/usr/share/texlive/texmf-dist/tex/xelatex/xecjk/xeCJK.cfg)) (/usr/share/texlive/texmf-dist/tex/latex/etoolbox/etoolbox.sty) Writing index file RCU.idx
(./RCU.aux)
Runaway argument?
{\contentsline {chapter}{\numberline {16}A Tour Through TREE\_RCU’s\ETC. ! File ended while scanning use of \@writefile.
<inserted text>
\par
l.191 \begin{document}

?

I suspect you are suffering from corrupt RCU.aux (or whatever other intermediate files xelatex generates).

What happens you run

    $ make cleandocs

before

    $ make SPHINXDIRS=RCU LATEXOPTS="-interaction=interactive" pdfdocs

?

Quoted 5 lines · Akira Yokosawa

I suspect you are suffering from corrupt RCU.aux (or whatever other intermediate files xelatex generates).

What happens you run

Quoted 7 lines

    $ make cleandocs

before

    $ make SPHINXDIRS=RCU LATEXOPTS="-interaction=interactive" pdfdocs

?

The last lines of that below:

LaTeX Warning: Float too large for page by 8477.29312pt on input line 10581.

LaTeX Warning: Hyper reference `Design/Memory-Ordering/Tree-RCU-Memory-Ordering :forcing-quiescent-states' on page 104 undefined on input line 10593.

LaTeX Warning: Float too large for page by 9533.29312pt on input line 11384.

LaTeX Warning: Hyper reference `Design/Memory-Ordering/Tree-RCU-Memory-Ordering :forcing-quiescent-states' on page 104 undefined on input line 11394.

[104] [105] [106]
! Dimension too large.
\color@b@x ... #3}\kern \fboxsep }\dimen@ \ht \z@
\advance \dimen@ \fboxsep ...
l.12718 \end{sphinxVerbatim}

?

Hmm, I can't reproduce this on docs-next.
On which tree are you building RCU.pdf?

Quoted 2 lines · Akira Yokosawa

Hmm, I can't reproduce this on docs-next.
On which tree are you building RCU.pdf?

Current linux-next. But I've also seen it with mainline from a few days ago.

Quoted 3 lines

Current linux-next. But I've also seen it with mainline from a few days ago.

Still can't reproduce with sphinx-build 4.3.2 on Debian bullseye.

What version of Sphinx are you using?

Quoted 4 lines · Akira Yokosawa

Quoted 3 lines

Current linux-next. But I've also seen it with mainline from a few days ago.

Quoted 3 lines

Still can't reproduce with sphinx-build 4.3.2 on Debian bullseye.

What version of Sphinx are you using?

The one that comes from Debian:

hch@brick:~/work/linux-next$ sphinx-build --version
sphinx-build 3.4.3

Quoted 5 lines · Akira Yokosawa

I suspect you are suffering from corrupt RCU.aux (or whatever other intermediate files xelatex generates).

What happens you run

Quoted 7 lines

    $ make cleandocs

before

    $ make SPHINXDIRS=RCU LATEXOPTS="-interaction=interactive" pdfdocs

?

The last lines of that below:

LaTeX Warning: Float too large for page by 8477.29312pt on input line 10581.

LaTeX Warning: Hyper reference `Design/Memory-Ordering/Tree-RCU-Memory-Ordering :forcing-quiescent-states' on page 104 undefined on input line 10593.

LaTeX Warning: Float too large for page by 9533.29312pt on input line 11384.

LaTeX Warning: Hyper reference `Design/Memory-Ordering/Tree-RCU-Memory-Ordering :forcing-quiescent-states' on page 104 undefined on input line 11394.

[104] [105] [106]
! Dimension too large.
\color@b@x ... #3}\kern \fboxsep }\dimen@ \ht \z@
\advance \dimen@ \fboxsep ...
l.12718 \end{sphinxVerbatim}

?

Hi, getting back to the error message, I remember seeing a similar error when I failed to permit PDF output of ImageMagick.

What I did back then was this (as root):

 # cd /etc/ImageMagick-6  
 # sed -i 's+policy domain="coder" rights="none" pattern="PDF"+policy domain="coder" rights="read|write" pattern="PDF"+' policy.xml ; \

In case this resolves your issue.

Quoted 8 lines · Akira Yokosawa

Hi, getting back to the error message, I remember seeing a similar error when I failed to permit PDF output of ImageMagick.

What I did back then was this (as root):

 # cd /etc/ImageMagick-6  
 # sed -i 's+policy domain="coder" rights="none" pattern="PDF"+policy domain="coder" rights="read|write" pattern="PDF"+' policy.xml ; \

Quoted 1 line

In case this resolves your issue.

I've definitively seen permission denied errors earlier in the (rather noisy) build log. But I absolutely do not feel comfortable changing global security policies for a kernel build, especially for something like ImageMagic that had its fair share of security issues. Is there any way to side step this by using a different tool?

Quoted 9 lines · Christoph Hellwig

Quoted 8 lines · Akira Yokosawa

Hi, getting back to the error message, I remember seeing a similar error when I failed to permit PDF output of ImageMagick.

What I did back then was this (as root):

 # cd /etc/ImageMagick-6  
 # sed -i 's+policy domain="coder" rights="none" pattern="PDF"+policy domain="coder" rights="read|write" pattern="PDF"+' policy.xml ; \

Quoted 8 lines

Quoted 1 line

In case this resolves your issue.

I've definitively seen permission denied errors earlier in the (rather noisy) build log. But I absolutely do not feel comfortable changing global security policies for a kernel build, especially for something like ImageMagic that had its fair share of security issues. Is there any way to side step this by using a different tool?

See my pending patch set at:

https://lore.kernel.org/linux-doc/[email protected]
[PATCH v2 0/4] docs: sphinx/kfigure.py: Improve conversion to PDF

This uses Inkscape if it is available instead of ImageMagick. No imagemagick nor librsvg2-bin is required.
As long as if you can trust Inkscape...

Good luck!

Thanks, Akira

Quoted 8 lines

See my pending patch set at:

https://lore.kernel.org/linux-doc/[email protected]
[PATCH v2 0/4] docs: sphinx/kfigure.py: Improve conversion to PDF

This uses Inkscape if it is available instead of ImageMagick. No imagemagick nor librsvg2-bin is required.
As long as if you can trust Inkscape...

Alternatively, you can avoid ImageMagick by installing graphicsmagick-imagemagick-compat instead of imagemagick.

I'm not sure what you think of GraphicsMagick, though.

If you'd like to try, do:

    $ sudo apt install graphicsmagick-imagemagick-compat ghostscript gsfonts-x11

This will remove ImageMagick.
(You have ghostscript and gsfonts-x11 already installed, I guess.)

Quoted 8 lines · Akira Yokosawa

Quoted 8 lines

See my pending patch set at:

https://lore.kernel.org/linux-doc/[email protected]
[PATCH v2 0/4] docs: sphinx/kfigure.py: Improve conversion to PDF

This uses Inkscape if it is available instead of ImageMagick. No imagemagick nor librsvg2-bin is required.
As long as if you can trust Inkscape...

I haven't gotten to try that yet..

Quoted 5 lines

Alternatively, you can avoid ImageMagick by installing graphicsmagick-imagemagick-compat instead of imagemagick.

I'm not sure what you think of GraphicsMagick, though.

Quoted 6 lines

If you'd like to try, do:

    $ sudo apt install graphicsmagick-imagemagick-compat ghostscript gsfonts-x11

This will remove ImageMagick.
(You have ghostscript and gsfonts-x11 already installed, I guess.)

This works just fine, thanks.