Skip to content

Commit d68d289

Browse files
committed
Merge tag 'docs-6.0-fixes' of git://git.lwn.net/linux
Pull documentation fixes from Jonathan Corbet: "A handful of fixes for documentation and the docs build system" * tag 'docs-6.0-fixes' of git://git.lwn.net/linux: docs/conf.py: add function attribute '__fix_address' to conf.py Docs/admin-guide/mm/damon/usage: fix the example code snip docs: Update version number from 5.x to 6.x in README.rst docs/ja_JP/SubmittingPatches: Remove reference to submitting-drivers.rst docs: kerneldoc-preamble: Test xeCJK.sty before loading
2 parents b90cb10 + 5479d6d commit d68d289

File tree

5 files changed

+42
-32
lines changed

5 files changed

+42
-32
lines changed

Documentation/admin-guide/README.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. _readme:
22

3-
Linux kernel release 5.x <http://kernel.org/>
3+
Linux kernel release 6.x <http://kernel.org/>
44
=============================================
55

6-
These are the release notes for Linux version 5. Read them carefully,
6+
These are the release notes for Linux version 6. Read them carefully,
77
as they tell you what this is all about, explain how to install the
88
kernel, and what to do if something goes wrong.
99

@@ -63,7 +63,7 @@ Installing the kernel source
6363
directory where you have permissions (e.g. your home directory) and
6464
unpack it::
6565

66-
xz -cd linux-5.x.tar.xz | tar xvf -
66+
xz -cd linux-6.x.tar.xz | tar xvf -
6767

6868
Replace "X" with the version number of the latest kernel.
6969

@@ -72,26 +72,26 @@ Installing the kernel source
7272
files. They should match the library, and not get messed up by
7373
whatever the kernel-du-jour happens to be.
7474

75-
- You can also upgrade between 5.x releases by patching. Patches are
75+
- You can also upgrade between 6.x releases by patching. Patches are
7676
distributed in the xz format. To install by patching, get all the
7777
newer patch files, enter the top level directory of the kernel source
78-
(linux-5.x) and execute::
78+
(linux-6.x) and execute::
7979

80-
xz -cd ../patch-5.x.xz | patch -p1
80+
xz -cd ../patch-6.x.xz | patch -p1
8181

8282
Replace "x" for all versions bigger than the version "x" of your current
8383
source tree, **in_order**, and you should be ok. You may want to remove
8484
the backup files (some-file-name~ or some-file-name.orig), and make sure
8585
that there are no failed patches (some-file-name# or some-file-name.rej).
8686
If there are, either you or I have made a mistake.
8787

88-
Unlike patches for the 5.x kernels, patches for the 5.x.y kernels
88+
Unlike patches for the 6.x kernels, patches for the 6.x.y kernels
8989
(also known as the -stable kernels) are not incremental but instead apply
90-
directly to the base 5.x kernel. For example, if your base kernel is 5.0
91-
and you want to apply the 5.0.3 patch, you must not first apply the 5.0.1
92-
and 5.0.2 patches. Similarly, if you are running kernel version 5.0.2 and
93-
want to jump to 5.0.3, you must first reverse the 5.0.2 patch (that is,
94-
patch -R) **before** applying the 5.0.3 patch. You can read more on this in
90+
directly to the base 6.x kernel. For example, if your base kernel is 6.0
91+
and you want to apply the 6.0.3 patch, you must not first apply the 6.0.1
92+
and 6.0.2 patches. Similarly, if you are running kernel version 6.0.2 and
93+
want to jump to 6.0.3, you must first reverse the 6.0.2 patch (that is,
94+
patch -R) **before** applying the 6.0.3 patch. You can read more on this in
9595
:ref:`Documentation/process/applying-patches.rst <applying_patches>`.
9696

9797
Alternatively, the script patch-kernel can be used to automate this
@@ -114,7 +114,7 @@ Installing the kernel source
114114
Software requirements
115115
---------------------
116116

117-
Compiling and running the 5.x kernels requires up-to-date
117+
Compiling and running the 6.x kernels requires up-to-date
118118
versions of various software packages. Consult
119119
:ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers
120120
required and how to get updates for these packages. Beware that using
@@ -132,12 +132,12 @@ Build directory for the kernel
132132
place for the output files (including .config).
133133
Example::
134134

135-
kernel source code: /usr/src/linux-5.x
135+
kernel source code: /usr/src/linux-6.x
136136
build directory: /home/name/build/kernel
137137

138138
To configure and build the kernel, use::
139139

140-
cd /usr/src/linux-5.x
140+
cd /usr/src/linux-6.x
141141
make O=/home/name/build/kernel menuconfig
142142
make O=/home/name/build/kernel
143143
sudo make O=/home/name/build/kernel modules_install install

Documentation/admin-guide/mm/damon/usage.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ For a short example, users can monitor the virtual address space of a given
5050
workload as below. ::
5151

5252
# cd /sys/kernel/mm/damon/admin/
53-
# echo 1 > kdamonds/nr && echo 1 > kdamonds/0/contexts/nr
53+
# echo 1 > kdamonds/nr_kdamonds && echo 1 > kdamonds/0/contexts/nr_contexts
5454
# echo vaddr > kdamonds/0/contexts/0/operations
55-
# echo 1 > kdamonds/0/contexts/0/targets/nr
56-
# echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid
55+
# echo 1 > kdamonds/0/contexts/0/targets/nr_targets
56+
# echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid_target
5757
# echo on > kdamonds/0/state
5858

5959
Files Hierarchy
@@ -366,12 +366,12 @@ memory rate becomes larger than 60%, or lower than 30%". ::
366366
# echo 1 > kdamonds/0/contexts/0/schemes/nr_schemes
367367
# cd kdamonds/0/contexts/0/schemes/0
368368
# # set the basic access pattern and the action
369-
# echo 4096 > access_patterns/sz/min
370-
# echo 8192 > access_patterns/sz/max
371-
# echo 0 > access_patterns/nr_accesses/min
372-
# echo 5 > access_patterns/nr_accesses/max
373-
# echo 10 > access_patterns/age/min
374-
# echo 20 > access_patterns/age/max
369+
# echo 4096 > access_pattern/sz/min
370+
# echo 8192 > access_pattern/sz/max
371+
# echo 0 > access_pattern/nr_accesses/min
372+
# echo 5 > access_pattern/nr_accesses/max
373+
# echo 10 > access_pattern/age/min
374+
# echo 20 > access_pattern/age/max
375375
# echo pageout > action
376376
# # set quotas
377377
# echo 10 > quotas/ms

Documentation/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@
8686
"__used",
8787
"__weak",
8888
"noinline",
89+
"__fix_address",
8990

9091
# include/linux/memblock.h:
9192
"__init_memblock",

Documentation/sphinx/kerneldoc-preamble.sty

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,16 @@
7070

7171
% Translations have Asian (CJK) characters which are only displayed if
7272
% xeCJK is used
73+
\usepackage{ifthen}
74+
\newboolean{enablecjk}
75+
\setboolean{enablecjk}{false}
7376
\IfFontExistsTF{Noto Sans CJK SC}{
74-
% Load xeCJK when CJK font is available
77+
\IfFileExists{xeCJK.sty}{
78+
\setboolean{enablecjk}{true}
79+
}{}
80+
}{}
81+
\ifthenelse{\boolean{enablecjk}}{
82+
% Load xeCJK when both the Noto Sans CJK font and xeCJK.sty are available.
7583
\usepackage{xeCJK}
7684
% Noto CJK fonts don't provide slant shape. [AutoFakeSlant] permits
7785
% its emulation.
@@ -196,22 +204,24 @@
196204
% Inactivate CJK after tableofcontents
197205
\apptocmd{\sphinxtableofcontents}{\kerneldocCJKoff}{}{}
198206
\xeCJKsetup{CJKspace = true}% For inter-phrase space of Korean TOC
199-
}{ % No CJK font found
207+
}{ % Don't enable CJK
200208
% Custom macros to on/off CJK and switch CJK fonts (Dummy)
201209
\newcommand{\kerneldocCJKon}{}
202210
\newcommand{\kerneldocCJKoff}{}
203211
%% By defining \kerneldocBegin(SC|TC|KR|JP) as commands with an argument
204212
%% and ignore the argument (#1) in their definitions, whole contents of
205213
%% CJK chapters can be ignored.
206214
\newcommand{\kerneldocBeginSC}[1]{%
207-
%% Put a note on missing CJK fonts in place of zh_CN translation.
208-
\begin{sphinxadmonition}{note}{Note on missing fonts:}
215+
%% Put a note on missing CJK fonts or the xecjk package in place of
216+
%% zh_CN translation.
217+
\begin{sphinxadmonition}{note}{Note on missing fonts and a package:}
209218
Translations of Simplified Chinese (zh\_CN), Traditional Chinese
210219
(zh\_TW), Korean (ko\_KR), and Japanese (ja\_JP) were skipped
211-
due to the lack of suitable font families.
220+
due to the lack of suitable font families and/or the texlive-xecjk
221+
package.
212222

213223
If you want them, please install ``Noto Sans CJK'' font families
214-
by following instructions from
224+
along with the texlive-xecjk package by following instructions from
215225
\sphinxcode{./scripts/sphinx-pre-install}.
216226
Having optional ``Noto Serif CJK'' font families will improve
217227
the looks of those translations.

Documentation/translations/ja_JP/SubmittingPatches

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ Linux カーネルに変更を加えたいと思っている個人又は会社
3535
てもらえやすくする提案を集めたものです。
3636

3737
コードを投稿する前に、Documentation/process/submit-checklist.rst の項目リストに目
38-
を通してチェックしてください。もしあなたがドライバーを投稿しようとし
39-
ているなら、Documentation/process/submitting-drivers.rst にも目を通してください。
38+
を通してチェックしてください。
4039

4140
--------------------------------------------
4241
セクション1 パッチの作り方と送り方

0 commit comments

Comments
 (0)