Skip to content

Commit 4ac6d90

Browse files
committed
Merge tag 'docs-5.15' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "Yet another set of documentation changes: - A reworking of PDF generation to yield better results for documents using CJK fonts in particular. - A new set of translations into traditional Chinese, a dialect for which I am assured there is a community of interested readers. - A lot more regular Chinese translation work as well. ... plus the usual assortment of updates, fixes, typo tweaks, etc" * tag 'docs-5.15' of git://git.lwn.net/linux: (55 commits) docs: sphinx-requirements: Move sphinx_rtd_theme to top docs: pdfdocs: Enable language-specific font choice of zh_TW translations docs: pdfdocs: Teach xeCJK about character classes of quotation marks docs: pdfdocs: Permit AutoFakeSlant for CJK fonts docs: pdfdocs: One-half spacing for CJK translations docs: pdfdocs: Add conf.py local to translations for ascii-art alignment docs: pdfdocs: Preserve inter-phrase space in Korean translations docs: pdfdocs: Choose Serif font as CJK mainfont if possible docs: pdfdocs: Add CJK-language-specific font settings docs: pdfdocs: Refactor config for CJK document scripts/kernel-doc: Override -Werror from KCFLAGS with KDOC_WERROR docs/zh_CN: Add zh_CN/accounting/psi.rst doc: align Italian translation Documentation/features/vm: riscv supports THP now docs/zh_CN: add infiniband user_verbs translation docs/zh_CN: add infiniband user_mad translation docs/zh_CN: add infiniband tag_matching translation docs/zh_CN: add infiniband sysfs translation docs/zh_CN: add infiniband opa_vnic translation docs/zh_CN: add infiniband ipoib translation ...
2 parents df43d90 + 37397b0 commit 4ac6d90

File tree

101 files changed

+13257
-130
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+13257
-130
lines changed

Documentation/admin-guide/cputopology.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ source for the output is in brackets ("[]").
5858
[NR_CPUS-1]
5959

6060
offline: CPUs that are not online because they have been
61-
HOTPLUGGED off (see cpu-hotplug.txt) or exceed the limit
62-
of CPUs allowed by the kernel configuration (kernel_max
63-
above). [~cpu_online_mask + cpus >= NR_CPUS]
61+
HOTPLUGGED off or exceed the limit of CPUs allowed by the
62+
kernel configuration (kernel_max above).
63+
[~cpu_online_mask + cpus >= NR_CPUS]
6464

6565
online: CPUs that are online and being scheduled [cpu_online_mask]
6666

@@ -96,5 +96,5 @@ online.)::
9696
possible: 0-127
9797
present: 0-3
9898

99-
See cpu-hotplug.txt for the possible_cpus=NUM kernel start parameter
100-
as well as more information on the various cpumasks.
99+
See Documentation/core-api/cpu_hotplug.rst for the possible_cpus=NUM
100+
kernel start parameter as well as more information on the various cpumasks.

Documentation/admin-guide/hw-vuln/core-scheduling.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,12 @@ Open cross-HT issues that core scheduling does not solve
181181
--------------------------------------------------------
182182
1. For MDS
183183
~~~~~~~~~~
184-
Core scheduling cannot protect against MDS attacks between an HT running in
185-
user mode and another running in kernel mode. Even though both HTs run tasks
186-
which trust each other, kernel memory is still considered untrusted. Such
187-
attacks are possible for any combination of sibling CPU modes (host or guest mode).
184+
Core scheduling cannot protect against MDS attacks between the siblings
185+
running in user mode and the others running in kernel mode. Even though all
186+
siblings run tasks which trust each other, when the kernel is executing
187+
code on behalf of a task, it cannot trust the code running in the
188+
sibling. Such attacks are possible for any combination of sibling CPU modes
189+
(host or guest mode).
188190

189191
2. For L1TF
190192
~~~~~~~~~~~

Documentation/admin-guide/sysrq.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ On PowerPC
7272

7373
On other
7474
If you know of the key combos for other architectures, please
75-
let me know so I can add them to this section.
75+
submit a patch to be included in this section.
7676

7777
On all
7878
Write a character to /proc/sysrq-trigger. e.g.::
@@ -205,10 +205,12 @@ frozen (probably root) filesystem via the FIFREEZE ioctl.
205205
Sometimes SysRq seems to get 'stuck' after using it, what can I do?
206206
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
207207

208-
That happens to me, also. I've found that tapping shift, alt, and control
209-
on both sides of the keyboard, and hitting an invalid sysrq sequence again
210-
will fix the problem. (i.e., something like :kbd:`alt-sysrq-z`). Switching to
211-
another virtual console (:kbd:`ALT+Fn`) and then back again should also help.
208+
When this happens, try tapping shift, alt and control on both sides of the
209+
keyboard, and hitting an invalid sysrq sequence again. (i.e., something like
210+
:kbd:`alt-sysrq-z`).
211+
212+
Switching to another virtual console (:kbd:`ALT+Fn`) and then back again
213+
should also help.
212214

213215
I hit SysRq, but nothing seems to happen, what's wrong?
214216
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Documentation/arm/marvell.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,19 @@ Kirkwood family
5858
- Product Brief : https://web.archive.org/web/20120616201621/http://www.marvell.com/embedded-processors/kirkwood/assets/88F6180-003_ver1.pdf
5959
- Hardware Spec : https://web.archive.org/web/20130730091654/http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6180_OpenSource.pdf
6060
- Functional Spec: https://web.archive.org/web/20130730091033/http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
61+
- 88F6280
62+
63+
- Product Brief : https://web.archive.org/web/20130730091058/http://www.marvell.com/embedded-processors/kirkwood/assets/88F6280_SoC_PB-001.pdf
6164
- 88F6281
6265

6366
- Product Brief : https://web.archive.org/web/20120131133709/http://www.marvell.com/embedded-processors/kirkwood/assets/88F6281-004_ver1.pdf
6467
- Hardware Spec : https://web.archive.org/web/20120620073511/http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6281_OpenSource.pdf
6568
- Functional Spec: https://web.archive.org/web/20130730091033/http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
69+
- 88F6321
70+
- 88F6322
71+
- 88F6323
72+
73+
- Product Brief : https://web.archive.org/web/20120616201639/http://www.marvell.com/embedded-processors/kirkwood/assets/88f632x_pb.pdf
6674
Homepage:
6775
https://web.archive.org/web/20160513194943/http://www.marvell.com/embedded-processors/kirkwood/
6876
Core:
@@ -89,6 +97,10 @@ Discovery family
8997

9098
- MV76100
9199

100+
- Product Brief : https://web.archive.org/web/20140722064429/http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV76100-002_WEB.pdf
101+
- Hardware Spec : https://web.archive.org/web/20140722064425/http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV76100_OpenSource.pdf
102+
- Functional Spec: https://web.archive.org/web/20111110081125/http://www.marvell.com/embedded-processors/discovery-innovation/assets/FS_MV76100_78100_78200_OpenSource.pdf
103+
92104
Not supported by the Linux kernel.
93105

94106
Core:
@@ -124,17 +136,23 @@ EBU Armada family
124136

125137
Armada 38x Flavors:
126138
- 88F6810 Armada 380
139+
- 88F6811 Armada 381
140+
- 88F6821 Armada 382
141+
- 88F6W21 Armada 383
127142
- 88F6820 Armada 385
128143
- 88F6828 Armada 388
129144

130145
- Product infos: https://web.archive.org/web/20181006144616/http://www.marvell.com/embedded-processors/armada-38x/
131146
- Functional Spec: https://web.archive.org/web/20200420191927/https://www.marvell.com/content/dam/marvell/en/public-collateral/embedded-processors/marvell-embedded-processors-armada-38x-functional-specifications-2015-11.pdf
147+
- Hardware Spec: https://web.archive.org/web/20180713105318/https://www.marvell.com/docs/embedded-processors/assets/marvell-embedded-processors-armada-38x-hardware-specifications-2017-03.pdf
148+
- Design guide: https://web.archive.org/web/20180712231737/https://www.marvell.com/docs/embedded-processors/assets/marvell-embedded-processors-armada-38x-hardware-design-guide-2017-08.pdf
132149

133150
Core:
134151
ARM Cortex-A9
135152

136153
Armada 39x Flavors:
137154
- 88F6920 Armada 390
155+
- 88F6925 Armada 395
138156
- 88F6928 Armada 398
139157

140158
- Product infos: https://web.archive.org/web/20181020222559/http://www.marvell.com/embedded-processors/armada-39x/

Documentation/conf.py

Lines changed: 105 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@
1616
import os
1717
import sphinx
1818

19-
from subprocess import check_output
20-
2119
# Get Sphinx version
2220
major, minor, patch = sphinx.version_info[:3]
2321

@@ -343,6 +341,9 @@
343341
verbatimhintsturnover=false,
344342
''',
345343

344+
# For CJK One-half spacing, need to be in front of hyperref
345+
'extrapackages': r'\usepackage{setspace}',
346+
346347
# Additional stuff for the LaTeX preamble.
347348
'preamble': '''
348349
% Prevent column squeezing of tabulary.
@@ -355,29 +356,117 @@
355356
''',
356357
}
357358

358-
# At least one book (translations) may have Asian characters
359-
# with are only displayed if xeCJK is used
359+
# Translations have Asian (CJK) characters which are only displayed if
360+
# xeCJK is used
360361

361-
cjk_cmd = check_output(['fc-list', '--format="%{family[0]}\n"']).decode('utf-8', 'ignore')
362-
if cjk_cmd.find("Noto Sans CJK SC") >= 0:
363-
latex_elements['preamble'] += '''
362+
latex_elements['preamble'] += '''
363+
\\IfFontExistsTF{Noto Sans CJK SC}{
364364
% This is needed for translations
365-
\\usepackage{xeCJK}
366-
\\setCJKmainfont{Noto Sans CJK SC}
365+
\\usepackage{xeCJK}
366+
\\IfFontExistsTF{Noto Serif CJK SC}{
367+
\\setCJKmainfont{Noto Serif CJK SC}[AutoFakeSlant]
368+
}{
369+
\\setCJKmainfont{Noto Sans CJK SC}[AutoFakeSlant]
370+
}
371+
\\setCJKsansfont{Noto Sans CJK SC}[AutoFakeSlant]
372+
\\setCJKmonofont{Noto Sans Mono CJK SC}[AutoFakeSlant]
373+
% CJK Language-specific font choices
374+
\\IfFontExistsTF{Noto Serif CJK SC}{
375+
\\newCJKfontfamily[SCmain]\\scmain{Noto Serif CJK SC}[AutoFakeSlant]
376+
\\newCJKfontfamily[SCserif]\\scserif{Noto Serif CJK SC}[AutoFakeSlant]
377+
}{
378+
\\newCJKfontfamily[SCmain]\\scmain{Noto Sans CJK SC}[AutoFakeSlant]
379+
\\newCJKfontfamily[SCserif]\\scserif{Noto Sans CJK SC}[AutoFakeSlant]
380+
}
381+
\\newCJKfontfamily[SCsans]\\scsans{Noto Sans CJK SC}[AutoFakeSlant]
382+
\\newCJKfontfamily[SCmono]\\scmono{Noto Sans Mono CJK SC}[AutoFakeSlant]
383+
\\IfFontExistsTF{Noto Serif CJK TC}{
384+
\\newCJKfontfamily[TCmain]\\tcmain{Noto Serif CJK TC}[AutoFakeSlant]
385+
\\newCJKfontfamily[TCserif]\\tcserif{Noto Serif CJK TC}[AutoFakeSlant]
386+
}{
387+
\\newCJKfontfamily[TCmain]\\tcmain{Noto Sans CJK TC}[AutoFakeSlant]
388+
\\newCJKfontfamily[TCserif]\\tcserif{Noto Sans CJK TC}[AutoFakeSlant]
389+
}
390+
\\newCJKfontfamily[TCsans]\\tcsans{Noto Sans CJK TC}[AutoFakeSlant]
391+
\\newCJKfontfamily[TCmono]\\tcmono{Noto Sans Mono CJK TC}[AutoFakeSlant]
392+
\\IfFontExistsTF{Noto Serif CJK KR}{
393+
\\newCJKfontfamily[KRmain]\\krmain{Noto Serif CJK KR}[AutoFakeSlant]
394+
\\newCJKfontfamily[KRserif]\\krserif{Noto Serif CJK KR}[AutoFakeSlant]
395+
}{
396+
\\newCJKfontfamily[KRmain]\\krmain{Noto Sans CJK KR}[AutoFakeSlant]
397+
\\newCJKfontfamily[KRserif]\\krserif{Noto Sans CJK KR}[AutoFakeSlant]
398+
}
399+
\\newCJKfontfamily[KRsans]\\krsans{Noto Sans CJK KR}[AutoFakeSlant]
400+
\\newCJKfontfamily[KRmono]\\krmono{Noto Sans Mono CJK KR}[AutoFakeSlant]
401+
\\IfFontExistsTF{Noto Serif CJK JP}{
402+
\\newCJKfontfamily[JPmain]\\jpmain{Noto Serif CJK JP}[AutoFakeSlant]
403+
\\newCJKfontfamily[JPserif]\\jpserif{Noto Serif CJK JP}[AutoFakeSlant]
404+
}{
405+
\\newCJKfontfamily[JPmain]\\jpmain{Noto Sans CJK JP}[AutoFakeSlant]
406+
\\newCJKfontfamily[JPserif]\\jpserif{Noto Sans CJK JP}[AutoFakeSlant]
407+
}
408+
\\newCJKfontfamily[JPsans]\\jpsans{Noto Sans CJK JP}[AutoFakeSlant]
409+
\\newCJKfontfamily[JPmono]\\jpmono{Noto Sans Mono CJK JP}[AutoFakeSlant]
410+
% Dummy commands for Sphinx < 2.3 (no 'extrapackages' support)
411+
\\providecommand{\\onehalfspacing}{}
412+
\\providecommand{\\singlespacing}{}
367413
% Define custom macros to on/off CJK
368-
\\newcommand{\\kerneldocCJKon}{\\makexeCJKactive}
369-
\\newcommand{\\kerneldocCJKoff}{\\makexeCJKinactive}
370-
% To customize \sphinxtableofcontents
414+
\\newcommand{\\kerneldocCJKon}{\\makexeCJKactive\\onehalfspacing}
415+
\\newcommand{\\kerneldocCJKoff}{\\makexeCJKinactive\\singlespacing}
416+
\\newcommand{\\kerneldocBeginSC}{%
417+
\\begingroup%
418+
\\scmain%
419+
}
420+
\\newcommand{\\kerneldocEndSC}{\\endgroup}
421+
\\newcommand{\\kerneldocBeginTC}{%
422+
\\begingroup%
423+
\\tcmain%
424+
\\renewcommand{\\CJKrmdefault}{TCserif}%
425+
\\renewcommand{\\CJKsfdefault}{TCsans}%
426+
\\renewcommand{\\CJKttdefault}{TCmono}%
427+
}
428+
\\newcommand{\\kerneldocEndTC}{\\endgroup}
429+
\\newcommand{\\kerneldocBeginKR}{%
430+
\\begingroup%
431+
\\xeCJKDeclareCharClass{HalfLeft}{`“,`‘}%
432+
\\xeCJKDeclareCharClass{HalfRight}{`”,`’}%
433+
\\krmain%
434+
\\renewcommand{\\CJKrmdefault}{KRserif}%
435+
\\renewcommand{\\CJKsfdefault}{KRsans}%
436+
\\renewcommand{\\CJKttdefault}{KRmono}%
437+
\\xeCJKsetup{CJKspace = true} % For inter-phrase space
438+
}
439+
\\newcommand{\\kerneldocEndKR}{\\endgroup}
440+
\\newcommand{\\kerneldocBeginJP}{%
441+
\\begingroup%
442+
\\xeCJKDeclareCharClass{HalfLeft}{`“,`‘}%
443+
\\xeCJKDeclareCharClass{HalfRight}{`”,`’}%
444+
\\jpmain%
445+
\\renewcommand{\\CJKrmdefault}{JPserif}%
446+
\\renewcommand{\\CJKsfdefault}{JPsans}%
447+
\\renewcommand{\\CJKttdefault}{JPmono}%
448+
}
449+
\\newcommand{\\kerneldocEndJP}{\\endgroup}
450+
% Single spacing in literal blocks
451+
\\fvset{baselinestretch=1}
452+
% To customize \\sphinxtableofcontents
371453
\\usepackage{etoolbox}
372454
% Inactivate CJK after tableofcontents
373455
\\apptocmd{\\sphinxtableofcontents}{\\kerneldocCJKoff}{}{}
374-
'''
375-
else:
376-
latex_elements['preamble'] += '''
456+
}{ % No CJK font found
377457
% Custom macros to on/off CJK (Dummy)
378458
\\newcommand{\\kerneldocCJKon}{}
379459
\\newcommand{\\kerneldocCJKoff}{}
380-
'''
460+
\\newcommand{\\kerneldocBeginSC}{}
461+
\\newcommand{\\kerneldocEndSC}{}
462+
\\newcommand{\\kerneldocBeginTC}{}
463+
\\newcommand{\\kerneldocEndTC}{}
464+
\\newcommand{\\kerneldocBeginKR}{}
465+
\\newcommand{\\kerneldocEndKR}{}
466+
\\newcommand{\\kerneldocBeginSC}{}
467+
\\newcommand{\\kerneldocEndKR}{}
468+
}
469+
'''
381470

382471
# Fix reference escape troubles with Sphinx 1.4.x
383472
if major == 1:

0 commit comments

Comments
 (0)