Skip to content

Commit

Permalink
docs/translations: Skip CJK contents if suitable fonts not found
Browse files Browse the repository at this point in the history
On systems without "Noto Sans CJK" fonts, CJK chapters in
translations.pdf are full of "TOFU" boxes, with a long build time and
a large log file containing lots of missing-font warnings.

Avoid such waste of time and resources by skipping CJK chapters when
CJK fonts are not available.

To skip whole chapters, change the definition of
\kerneldocBegin{SC|TC|KR|JP} commands so that they can have an argument
to be ignored.
This works as far as the argument (#1) is not used in the command.
In place of skipped contents, put a note on skipped contents at the
beginning of the PDF.

Change the call sites in index.rst of CJK translations accordingly.

When CJK fonts are available, existing command definitions with
no argument just work.  LaTeX engine will see additional pairs of
"{" and "}", which add a level of grouping without having any effect
on typesetting.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/3359ca41-b81d-b2c7-e437-7618efbe241d@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Akira Yokosawa authored and Jonathan Corbet committed Feb 15, 2022
1 parent 7b686a2 commit 5d9158e
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 13 deletions.
13 changes: 9 additions & 4 deletions Documentation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -563,13 +563,18 @@
% Custom macros to on/off CJK (Dummy)
\\newcommand{\\kerneldocCJKon}{}
\\newcommand{\\kerneldocCJKoff}{}
\\newcommand{\\kerneldocBeginSC}{}
\\newcommand{\\kerneldocBeginSC}[1]{%
\\begin{sphinxadmonition}{note}{Note:}
``Noto Sans CJK'' fonts are not found while building this PDF\\@.
Translations of zh\\_CN, zh\\_TW, ko\\_KR, and ja\\_JP are
skipped.
\\end{sphinxadmonition}}
\\newcommand{\\kerneldocEndSC}{}
\\newcommand{\\kerneldocBeginTC}{}
\\newcommand{\\kerneldocBeginTC}[1]{}
\\newcommand{\\kerneldocEndTC}{}
\\newcommand{\\kerneldocBeginKR}{}
\\newcommand{\\kerneldocBeginKR}[1]{}
\\newcommand{\\kerneldocEndKR}{}
\\newcommand{\\kerneldocBeginJP}{}
\\newcommand{\\kerneldocBeginJP}[1]{}
\\newcommand{\\kerneldocEndJP}{}
}
'''
Expand Down
4 changes: 2 additions & 2 deletions Documentation/translations/ja_JP/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
\renewcommand\thesection*
\renewcommand\thesubsection*
\kerneldocCJKon
\kerneldocBeginJP
\kerneldocBeginJP{

Japanese translations
=====================
Expand All @@ -15,4 +15,4 @@ Japanese translations

.. raw:: latex

\kerneldocEndJP
}\kerneldocEndJP
5 changes: 2 additions & 3 deletions Documentation/translations/ko_KR/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
\renewcommand\thesection*
\renewcommand\thesubsection*
\kerneldocCJKon
\kerneldocBeginKR
\kerneldocBeginKR{

한국어 번역
===========
Expand All @@ -26,5 +26,4 @@

.. raw:: latex

\normalsize
\kerneldocEndKR
}\kerneldocEndKR
4 changes: 2 additions & 2 deletions Documentation/translations/zh_CN/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
\renewcommand\thesection*
\renewcommand\thesubsection*
\kerneldocCJKon
\kerneldocBeginSC
\kerneldocBeginSC{

.. _linux_doc_zh:

Expand Down Expand Up @@ -198,4 +198,4 @@ TODOList:

.. raw:: latex

\kerneldocEndSC
}\kerneldocEndSC
4 changes: 2 additions & 2 deletions Documentation/translations/zh_TW/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
\renewcommand\thesection*
\renewcommand\thesubsection*
\kerneldocCJKon
\kerneldocBeginTC
\kerneldocBeginTC{

.. _linux_doc_zh_tw:

Expand Down Expand Up @@ -174,4 +174,4 @@ TODOList:

.. raw:: latex

\kerneldocEndTC
}\kerneldocEndTC

0 comments on commit 5d9158e

Please sign in to comment.