Commits · 37397b092e7f4b520a257aaafe83f868cd3d5e27 · Kirill Smelkov / linux

12 Aug, 2021 30 commits

docs: sphinx-requirements: Move sphinx_rtd_theme to top · 37397b09

Akira Yokosawa authored Aug 10, 2021

sphinx_rtd_theme 0.5.2 has "docutils<0.17" in its requirements.
docutils 0.17 released this April caused regression in
sphinx_rtd_theme 0.5.1 [1].

By removing docutils and moving sphinx_rtd_theme before Sphinx in
requirements.txt, the requirement of "docutils<0.17" can be met
naturally.

[1]: https://github.com/readthedocs/sphinx_rtd_theme/issues/1112Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/75f14c88-6091-1072-41cb-16b886aee5a0@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

37397b09

docs: pdfdocs: Enable language-specific font choice of zh_TW translations · e0d14a5d

Akira Yokosawa authored Aug 09, 2021

The "TC" variants are supposed to be the choice for traditional
Chinese documents.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Reviewed-by: Hu Haowen <src.res@email.cn>
Tested-by: Hu Haowen <src.res@email.cn>
Link: https://lore.kernel.org/r/9d8e8fa2-3e7a-3a0a-1a0d-7d797a605ff8@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

e0d14a5d

docs: pdfdocs: Teach xeCJK about character classes of quotation marks · 29ac9822

Akira Yokosawa authored Aug 09, 2021

Quotation marks in "KR" and "JP" variants of Noto CJK fonts are half
width.
xeCJK assumes they are full width by default and does excessive kerning
around them in Korean and Japanese translations.

Give xeCJK proper hints by the \xeCJKDeclareCharClass command.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/0da9e3c5-2716-f576-1df5-2f28ea69f0e8@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

29ac9822

docs: pdfdocs: Permit AutoFakeSlant for CJK fonts · 788d28a2

Akira Yokosawa authored Aug 09, 2021

Noto CJK fonts don't provide italic shapes.
The AutoFakeSlant option of fontspec and xeCJK packages can be used as
a workaround.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/502335cc-9a95-3c2a-7744-6cc56ecaf628@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

788d28a2

docs: pdfdocs: One-half spacing for CJK translations · 77abc2c2

Akira Yokosawa authored Aug 09, 2021

CJK documents are much easier to read with a wider baseline stretch.
Applying onehalfspacing option of "setspace" package looks reasonable.

Note: \usepackage{setspace} needs to be before that of hyperref in the
preamble.
The 'extrapackages' key (available since Sphinx 2.3) is for this purpose.
For systems with Sphinx < 2.3, dummy commands of \onehalfspacing and
\singlespacing are provided instead.
One-half spacing is not effective in LaTeX sources generated by such
revisions of Sphinx.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/547a1f1c-0bb5-20a7-ea0e-951bfc3c3925@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

77abc2c2

docs: pdfdocs: Add conf.py local to translations for ascii-art alignment · a90dad8f

Akira Yokosawa authored Aug 09, 2021

Globally choosing "Noto Sans Mono CJK SC" would result in sub-optimal look
of literal blocks in Latin documents.
Therefore, localize the font choice to translations by adding conf.py under
Documentation/translations/.

The local conf.py is enabled when the command:

    make SPHINXDIRS=translations pdfdocs

is used to build the PDF.
Resulting translations.pdf (under Documentation/output/translations/pdf)
will have properly aligned ascii-art figures.

NOTE: There remain mis-aligned ascii-art figures in Korean translations.
This is due to the font designer's decision to assign slightly narrower
widths (920) to Hangul characters in "Noto Sans Mono CJK KR" than those
of Hanja (Hanzi/Kanji) characters (1000) [1].

[1]: https://github.com/googlefonts/noto-cjk/issues/17Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/79a876fc-a552-f972-4a1b-c6df4cbb36dd@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

a90dad8f

docs: pdfdocs: Preserve inter-phrase space in Korean translations · 35382965

Akira Yokosawa authored Aug 09, 2021

In Korean typesetting, inter-phrase spaces in Hangul text have
a similar role as the the inter-word spaces in Latin text.
They can be preserved by the \xeCJKsetup{CJKspace=true} option.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/68de2e52-e6d1-3f01-c097-15ba7b28a319@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

35382965

docs: pdfdocs: Choose Serif font as CJK mainfont if possible · 7eb368cc

Akira Yokosawa authored Aug 09, 2021

"Noto Serif CJK SC" and its variants suit better with the roman font
of Latin letters.

On some distros such as Fedora, it is possible to partially install
"Noto Sans CJK" fonts.
So, if the Serif fonts are not found on the system, fall back to the
Sans fonts.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/5e454140-5d0c-35d4-8c31-3ffb2420793a@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

7eb368cc

docs: pdfdocs: Add CJK-language-specific font settings · e291ff6f

Akira Yokosawa authored Aug 09, 2021

zh_TW, ko_KR, and ja_JP translations have their preferred glyph sets
different from that of zh_CN.

To switch CJK font in the middle of the translations, introduce custom
LaTeX macros listed below:

    \kerneldocBeginSC
    \kerneldocEndSC
    \kerneldocBeginTC
    \kerneldocEndTC
    \kerneldocBeginKR
    \kerneldocEndKR
    \kerneldocBeginJP
    \kerneldocEndJP

, and embed a pair of macros in each language's index.rst.

NOTE 1: Update of zh_TW/index.rst is deferred to a follow-up change.

NOTE 2: Custom macros added here do not imply \kerneldocCJK(on|off).
This is intentional.  For example, \kerneldocCJKoff needs to be
at the top of Italian translations' index.rst for the footer of
final zh_TW page to be properly typeset.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/31906baf-7490-68cd-7153-4e4d320fb9b0@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

e291ff6f

docs: pdfdocs: Refactor config for CJK document · 659653c9

Akira Yokosawa authored Aug 09, 2021

To make generated LaTeX code portable across systems with different sets
of available fonts, convert font-availability check in python code to
LaTeX code by using a conditional command provided by the "fontspec"
package.

This will help those who run Sphinx on one machine/container and run
latexmk on other machines/containers.

Remove import of check_output as it is unused any more.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/4baf88af-316d-8aee-240f-6ccbc20907d7@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

659653c9

scripts/kernel-doc: Override -Werror from KCFLAGS with KDOC_WERROR · bed4ed30

Laurent Pinchart authored Jul 31, 2021

Since commit 2c12c810 ("scripts/kernel-doc: optionally treat
warnings as errors"), the kernel-doc script will treat warnings as
errors when one of the following conditions is true:

- The KDOC_WERROR environment variable is non-zero
- The KCFLAGS environment variable contains -Werror
- The -Werror parameter is passed to kernel-doc

Checking KCFLAGS for -Werror allows piggy-backing on the C compiler
error handling. However, unlike the C compiler, kernel-doc has no
provision for -Wno-error. This makes compiling the kernel with -Werror
(to catch regressions) and W=1 (to enable more checks) always fail,
without the same possibility as offered by the C compiler to treating
some selected warnings as warnings despite the global -Werror setting.

To fix this, evaluate KDOC_WERROR after KCFLAGS, which allows disabling
the warnings-as-errors behaviour of kernel-doc selectively by setting
KDOC_WERROR=0.
Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Link: https://lore.kernel.org/r/20210730225401.4401-1-laurent.pinchart+renesas@ideasonboard.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

bed4ed30

docs/zh_CN: Add zh_CN/accounting/psi.rst · 4f3791c3

Yang Yang authored Jul 31, 2021

Add translation zh_CN/accounting/psi.rst and zh_CN/accounting/index.rst.
Signed-off-by: Yang Yang <yang.yang29@zte.com.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
Link: https://lore.kernel.org/r/20210731084502.571451-1-yang.yang29@zte.com.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>

4f3791c3

doc: align Italian translation · 191cf329

Federico Vaga authored Jul 31, 2021

Translation for the following patches

commit 0ca0d555 ("docs/core-api: Consistent code style")
commit 9912d0bb ("docs: process: submitting-patches.rst: avoid using ReST :doc:`foo` markup")
commit 6349469a ("Documentation/submitting-patches: Document RESEND tag on patches")
commit dbbe7c96 ("docs: networking: drop special stable handling")
commit 7f3f7bfb ("docs: kernel-hacking: hacking.rst: avoid using ReST :doc:`foo` markup")
commit 6ab0493d ("deprecated.rst: Include details on "no_hash_pointers" ")
commit 77167b96 ("docs: submitting-patches: clarify the role of LKML ")
Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20210731085513.11820-1-federico.vaga@vaga.pv.itSigned-off-by: Jonathan Corbet <corbet@lwn.net>

191cf329

Documentation/features/vm: riscv supports THP now · 27f373cb

Jisheng Zhang authored Aug 05, 2021

After commit e88b3331 ("riscv: mm: add THP support on 64-bit"),
riscv can support THP.
Signed-off-by: Jisheng Zhang <jszhang@kernel.org>
Link: https://lore.kernel.org/r/20210805002739.23f44d2d@xhackerSigned-off-by: Jonathan Corbet <corbet@lwn.net>