1. Patchew
  2. linux
  3. [PATCH v2 0/3] docs: conf.py: Reduce texlive dependency
  4. View patch

[PATCH v2 3/3] docs: kerneldoc-preamble: Test xeCJK.sty before loading

Akira Yokosawa posted 3 patches 3 years, 8 months ago
There is a newer version of this series
[PATCH v2 3/3] docs: kerneldoc-preamble: Test xeCJK.sty before loading
Posted by Akira Yokosawa 3 years, 8 months ago 
On distros whose texlive packaging is fine-grained, texlive-xecjk
can be installed/removed independently of other texlive packages.
Conditionally loading xeCJK depending only on the existence of the
"Noto Sans CJK SC" font might end up in xelatex error of
"xeCJK.sty not found!".

Improve the situation by testing existence of xeCJK.sty before
loading it.

This is useful on RHEL 9 and its clone distros where texlive-xecjk
doesn't work at the moment due to a missing dependency [1].
"make pdfdocs" for non-CJK contents should work after removing
texlive-xecjk.

Link: [1] https://bugzilla.redhat.com/show_bug.cgi?id=2086254
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---
Changes since v1:
 - Acked-by from Mauro.

--
 Documentation/sphinx/kerneldoc-preamble.sty | 22 +++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/Documentation/sphinx/kerneldoc-preamble.sty b/Documentation/sphinx/kerneldoc-preamble.sty
index 2a29cbe51396..9707e033c8c4 100644
--- a/Documentation/sphinx/kerneldoc-preamble.sty
+++ b/Documentation/sphinx/kerneldoc-preamble.sty
@@ -70,8 +70,16 @@
 
 % Translations have Asian (CJK) characters which are only displayed if
 % xeCJK is used
+\usepackage{ifthen}
+\newboolean{enablecjk}
+\setboolean{enablecjk}{false}
 \IfFontExistsTF{Noto Sans CJK SC}{
-    % Load xeCJK when CJK font is available
+    \IfFileExists{xeCJK.sty}{
+	\setboolean{enablecjk}{true}
+    }{}
+}{}
+\ifthenelse{\boolean{enablecjk}}{
+    % Load xeCJK when both the Noto Sans CJK font and xeCJK.sty are available.
     \usepackage{xeCJK}
     % Noto CJK fonts don't provide slant shape. [AutoFakeSlant] permits
     % its emulation.
@@ -196,7 +204,7 @@
     % Inactivate CJK after tableofcontents
     \apptocmd{\sphinxtableofcontents}{\kerneldocCJKoff}{}{}
     \xeCJKsetup{CJKspace = true}% For inter-phrase space of Korean TOC
-}{ % No CJK font found
+}{ % Don't enable CJK
     % Custom macros to on/off CJK and switch CJK fonts (Dummy)
     \newcommand{\kerneldocCJKon}{}
     \newcommand{\kerneldocCJKoff}{}
@@ -204,14 +212,16 @@
     %% and ignore the argument (#1) in their definitions, whole contents of
     %% CJK chapters can be ignored.
     \newcommand{\kerneldocBeginSC}[1]{%
-	%% Put a note on missing CJK fonts in place of zh_CN translation.
-	\begin{sphinxadmonition}{note}{Note on missing fonts:}
+	%% Put a note on missing CJK fonts or the xecjk package in place of
+	%% zh_CN translation.
+	\begin{sphinxadmonition}{note}{Note on missing fonts and a package:}
 	    Translations of Simplified Chinese (zh\_CN), Traditional Chinese
 	    (zh\_TW), Korean (ko\_KR), and Japanese (ja\_JP) were skipped
-	    due to the lack of suitable font families.
+	    due to the lack of suitable font families and/or the texlive-xecjk
+	    package.
 
 	    If you want them, please install ``Noto Sans CJK'' font families
-	    by following instructions from
+	    along with the texlive-xecjk package by following instructions from
 	    \sphinxcode{./scripts/sphinx-pre-install}.
 	    Having optional ``Noto Serif CJK'' font families will improve
 	    the looks of those translations.
-- 
2.25.1
Re: [PATCH v2 3/3] docs: kerneldoc-preamble: Test xeCJK.sty before loading
Posted by Akira Yokosawa 3 years, 5 months ago 
On Mon, 8 Aug 2022 17:53:57 +0900, Akira Yokosawa wrote:
> On distros whose texlive packaging is fine-grained, texlive-xecjk
> can be installed/removed independently of other texlive packages.
> Conditionally loading xeCJK depending only on the existence of the
> "Noto Sans CJK SC" font might end up in xelatex error of
> "xeCJK.sty not found!".
> 
> Improve the situation by testing existence of xeCJK.sty before
> loading it.
> 
> This is useful on RHEL 9 and its clone distros where texlive-xecjk
> doesn't work at the moment due to a missing dependency [1].
> "make pdfdocs" for non-CJK contents should work after removing
> texlive-xecjk.
> 
> Link: [1] https://bugzilla.redhat.com/show_bug.cgi?id=2086254
FWIW, this ticket was closed recently. It took five months. Whew...

Now EPEL 9 carries texlive-ctex and its dependencies.
It is now possible to build pdfdocs with CJK contents within the
confinement of RHEL 9 and its clones' packages as long as you are
OK with enabling EPEL 9.

        Thanks, Akira

> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>
[...]
Re: [PATCH v2 3/3] docs: kerneldoc-preamble: Test xeCJK.sty before loading
Posted by Akira Yokosawa 3 years, 8 months ago 
Hi Jon,

On Mon, 8 Aug 2022 17:53:57 +0900, Akira Yokosawa wrote:
> On distros whose texlive packaging is fine-grained, texlive-xecjk
> can be installed/removed independently of other texlive packages.
> Conditionally loading xeCJK depending only on the existence of the
> "Noto Sans CJK SC" font might end up in xelatex error of
> "xeCJK.sty not found!".
> 
> Improve the situation by testing existence of xeCJK.sty before
> loading it.
> 
> This is useful on RHEL 9 and its clone distros where texlive-xecjk
> doesn't work at the moment due to a missing dependency [1].
> "make pdfdocs" for non-CJK contents should work after removing
> texlive-xecjk.
In hindsight, I think this qualifies as a stable material.
Let me append a couple of tags.

> 
> Link: [1] https://bugzilla.redhat.com/show_bug.cgi?id=2086254
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Fixes: 398f7abdcb7e ("docs: pdfdocs: Pull LaTeX preamble part out of conf.py")
Cc: stable@vger.kernel.org # v5.18+

Jon, it's up to you whether this one is destined for v6.0-rcX or
for the next merge window.  It has no dependency on patches 1/3
and 2/3.

        Thanks, Akira
Re: [PATCH v2 3/3] docs: kerneldoc-preamble: Test xeCJK.sty before loading
Posted by Jonathan Corbet 3 years, 7 months ago 
Akira Yokosawa <akiyks@gmail.com> writes:

> Hi Jon,
>
> On Mon, 8 Aug 2022 17:53:57 +0900, Akira Yokosawa wrote:
>> On distros whose texlive packaging is fine-grained, texlive-xecjk
>> can be installed/removed independently of other texlive packages.
>> Conditionally loading xeCJK depending only on the existence of the
>> "Noto Sans CJK SC" font might end up in xelatex error of
>> "xeCJK.sty not found!".
>> 
>> Improve the situation by testing existence of xeCJK.sty before
>> loading it.
>> 
>> This is useful on RHEL 9 and its clone distros where texlive-xecjk
>> doesn't work at the moment due to a missing dependency [1].
>> "make pdfdocs" for non-CJK contents should work after removing
>> texlive-xecjk.
> In hindsight, I think this qualifies as a stable material.
> Let me append a couple of tags.
>
>> 
>> Link: [1] https://bugzilla.redhat.com/show_bug.cgi?id=2086254
>> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
>> Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> Fixes: 398f7abdcb7e ("docs: pdfdocs: Pull LaTeX preamble part out of conf.py")
> Cc: stable@vger.kernel.org # v5.18+
>
> Jon, it's up to you whether this one is destined for v6.0-rcX or
> for the next merge window.  It has no dependency on patches 1/3
> and 2/3.

OK, I've gone ahead and applied it with those tags.

Thanks,

jon

Patchew 2.1-devel-ea86937

© 2016 - 2026 Red Hat, Inc.