Commit d68d289f authored by Linus Torvalds's avatar Linus Torvalds

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
parents b90cb105 5479d6d4
.. _readme: .. _readme:
Linux kernel release 5.x <http://kernel.org/> Linux kernel release 6.x <http://kernel.org/>
============================================= =============================================
These are the release notes for Linux version 5. Read them carefully, These are the release notes for Linux version 6. Read them carefully,
as they tell you what this is all about, explain how to install the as they tell you what this is all about, explain how to install the
kernel, and what to do if something goes wrong. kernel, and what to do if something goes wrong.
...@@ -63,7 +63,7 @@ Installing the kernel source ...@@ -63,7 +63,7 @@ Installing the kernel source
directory where you have permissions (e.g. your home directory) and directory where you have permissions (e.g. your home directory) and
unpack it:: unpack it::
xz -cd linux-5.x.tar.xz | tar xvf - xz -cd linux-6.x.tar.xz | tar xvf -
Replace "X" with the version number of the latest kernel. Replace "X" with the version number of the latest kernel.
...@@ -72,12 +72,12 @@ Installing the kernel source ...@@ -72,12 +72,12 @@ Installing the kernel source
files. They should match the library, and not get messed up by files. They should match the library, and not get messed up by
whatever the kernel-du-jour happens to be. whatever the kernel-du-jour happens to be.
- You can also upgrade between 5.x releases by patching. Patches are - You can also upgrade between 6.x releases by patching. Patches are
distributed in the xz format. To install by patching, get all the distributed in the xz format. To install by patching, get all the
newer patch files, enter the top level directory of the kernel source newer patch files, enter the top level directory of the kernel source
(linux-5.x) and execute:: (linux-6.x) and execute::
xz -cd ../patch-5.x.xz | patch -p1 xz -cd ../patch-6.x.xz | patch -p1
Replace "x" for all versions bigger than the version "x" of your current Replace "x" for all versions bigger than the version "x" of your current
source tree, **in_order**, and you should be ok. You may want to remove source tree, **in_order**, and you should be ok. You may want to remove
...@@ -85,13 +85,13 @@ Installing the kernel source ...@@ -85,13 +85,13 @@ Installing the kernel source
that there are no failed patches (some-file-name# or some-file-name.rej). that there are no failed patches (some-file-name# or some-file-name.rej).
If there are, either you or I have made a mistake. If there are, either you or I have made a mistake.
Unlike patches for the 5.x kernels, patches for the 5.x.y kernels Unlike patches for the 6.x kernels, patches for the 6.x.y kernels
(also known as the -stable kernels) are not incremental but instead apply (also known as the -stable kernels) are not incremental but instead apply
directly to the base 5.x kernel. For example, if your base kernel is 5.0 directly to the base 6.x kernel. For example, if your base kernel is 6.0
and you want to apply the 5.0.3 patch, you must not first apply the 5.0.1 and you want to apply the 6.0.3 patch, you must not first apply the 6.0.1
and 5.0.2 patches. Similarly, if you are running kernel version 5.0.2 and and 6.0.2 patches. Similarly, if you are running kernel version 6.0.2 and
want to jump to 5.0.3, you must first reverse the 5.0.2 patch (that is, want to jump to 6.0.3, you must first reverse the 6.0.2 patch (that is,
patch -R) **before** applying the 5.0.3 patch. You can read more on this in patch -R) **before** applying the 6.0.3 patch. You can read more on this in
:ref:`Documentation/process/applying-patches.rst <applying_patches>`. :ref:`Documentation/process/applying-patches.rst <applying_patches>`.
Alternatively, the script patch-kernel can be used to automate this Alternatively, the script patch-kernel can be used to automate this
...@@ -114,7 +114,7 @@ Installing the kernel source ...@@ -114,7 +114,7 @@ Installing the kernel source
Software requirements Software requirements
--------------------- ---------------------
Compiling and running the 5.x kernels requires up-to-date Compiling and running the 6.x kernels requires up-to-date
versions of various software packages. Consult versions of various software packages. Consult
:ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers :ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers
required and how to get updates for these packages. Beware that using required and how to get updates for these packages. Beware that using
...@@ -132,12 +132,12 @@ Build directory for the kernel ...@@ -132,12 +132,12 @@ Build directory for the kernel
place for the output files (including .config). place for the output files (including .config).
Example:: Example::
kernel source code: /usr/src/linux-5.x kernel source code: /usr/src/linux-6.x
build directory: /home/name/build/kernel build directory: /home/name/build/kernel
To configure and build the kernel, use:: To configure and build the kernel, use::
cd /usr/src/linux-5.x cd /usr/src/linux-6.x
make O=/home/name/build/kernel menuconfig make O=/home/name/build/kernel menuconfig
make O=/home/name/build/kernel make O=/home/name/build/kernel
sudo make O=/home/name/build/kernel modules_install install sudo make O=/home/name/build/kernel modules_install install
......
...@@ -50,10 +50,10 @@ For a short example, users can monitor the virtual address space of a given ...@@ -50,10 +50,10 @@ For a short example, users can monitor the virtual address space of a given
workload as below. :: workload as below. ::
# cd /sys/kernel/mm/damon/admin/ # cd /sys/kernel/mm/damon/admin/
# echo 1 > kdamonds/nr && echo 1 > kdamonds/0/contexts/nr # echo 1 > kdamonds/nr_kdamonds && echo 1 > kdamonds/0/contexts/nr_contexts
# echo vaddr > kdamonds/0/contexts/0/operations # echo vaddr > kdamonds/0/contexts/0/operations
# echo 1 > kdamonds/0/contexts/0/targets/nr # echo 1 > kdamonds/0/contexts/0/targets/nr_targets
# echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid # echo $(pidof <workload>) > kdamonds/0/contexts/0/targets/0/pid_target
# echo on > kdamonds/0/state # echo on > kdamonds/0/state
Files Hierarchy Files Hierarchy
...@@ -366,12 +366,12 @@ memory rate becomes larger than 60%, or lower than 30%". :: ...@@ -366,12 +366,12 @@ memory rate becomes larger than 60%, or lower than 30%". ::
# echo 1 > kdamonds/0/contexts/0/schemes/nr_schemes # echo 1 > kdamonds/0/contexts/0/schemes/nr_schemes
# cd kdamonds/0/contexts/0/schemes/0 # cd kdamonds/0/contexts/0/schemes/0
# # set the basic access pattern and the action # # set the basic access pattern and the action
# echo 4096 > access_patterns/sz/min # echo 4096 > access_pattern/sz/min
# echo 8192 > access_patterns/sz/max # echo 8192 > access_pattern/sz/max
# echo 0 > access_patterns/nr_accesses/min # echo 0 > access_pattern/nr_accesses/min
# echo 5 > access_patterns/nr_accesses/max # echo 5 > access_pattern/nr_accesses/max
# echo 10 > access_patterns/age/min # echo 10 > access_pattern/age/min
# echo 20 > access_patterns/age/max # echo 20 > access_pattern/age/max
# echo pageout > action # echo pageout > action
# # set quotas # # set quotas
# echo 10 > quotas/ms # echo 10 > quotas/ms
......
...@@ -86,6 +86,7 @@ if major >= 3: ...@@ -86,6 +86,7 @@ if major >= 3:
"__used", "__used",
"__weak", "__weak",
"noinline", "noinline",
"__fix_address",
# include/linux/memblock.h: # include/linux/memblock.h:
"__init_memblock", "__init_memblock",
......
...@@ -70,8 +70,16 @@ ...@@ -70,8 +70,16 @@
% Translations have Asian (CJK) characters which are only displayed if % Translations have Asian (CJK) characters which are only displayed if
% xeCJK is used % xeCJK is used
\usepackage{ifthen}
\newboolean{enablecjk}
\setboolean{enablecjk}{false}
\IfFontExistsTF{Noto Sans CJK SC}{ \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} \usepackage{xeCJK}
% Noto CJK fonts don't provide slant shape. [AutoFakeSlant] permits % Noto CJK fonts don't provide slant shape. [AutoFakeSlant] permits
% its emulation. % its emulation.
...@@ -196,7 +204,7 @@ ...@@ -196,7 +204,7 @@
% Inactivate CJK after tableofcontents % Inactivate CJK after tableofcontents
\apptocmd{\sphinxtableofcontents}{\kerneldocCJKoff}{}{} \apptocmd{\sphinxtableofcontents}{\kerneldocCJKoff}{}{}
\xeCJKsetup{CJKspace = true}% For inter-phrase space of Korean TOC \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) % Custom macros to on/off CJK and switch CJK fonts (Dummy)
\newcommand{\kerneldocCJKon}{} \newcommand{\kerneldocCJKon}{}
\newcommand{\kerneldocCJKoff}{} \newcommand{\kerneldocCJKoff}{}
...@@ -204,14 +212,16 @@ ...@@ -204,14 +212,16 @@
%% and ignore the argument (#1) in their definitions, whole contents of %% and ignore the argument (#1) in their definitions, whole contents of
%% CJK chapters can be ignored. %% CJK chapters can be ignored.
\newcommand{\kerneldocBeginSC}[1]{% \newcommand{\kerneldocBeginSC}[1]{%
%% Put a note on missing CJK fonts in place of zh_CN translation. %% Put a note on missing CJK fonts or the xecjk package in place of
\begin{sphinxadmonition}{note}{Note on missing fonts:} %% zh_CN translation.
\begin{sphinxadmonition}{note}{Note on missing fonts and a package:}
Translations of Simplified Chinese (zh\_CN), Traditional Chinese Translations of Simplified Chinese (zh\_CN), Traditional Chinese
(zh\_TW), Korean (ko\_KR), and Japanese (ja\_JP) were skipped (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 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}. \sphinxcode{./scripts/sphinx-pre-install}.
Having optional ``Noto Serif CJK'' font families will improve Having optional ``Noto Serif CJK'' font families will improve
the looks of those translations. the looks of those translations.
......
...@@ -35,8 +35,7 @@ Linux カーネルに変更を加えたいと思っている個人又は会社 ...@@ -35,8 +35,7 @@ Linux カーネルに変更を加えたいと思っている個人又は会社
てもらえやすくする提案を集めたものです。 てもらえやすくする提案を集めたものです。
コードを投稿する前に、Documentation/process/submit-checklist.rst の項目リストに目 コードを投稿する前に、Documentation/process/submit-checklist.rst の項目リストに目
を通してチェックしてください。もしあなたがドライバーを投稿しようとし を通してチェックしてください。
ているなら、Documentation/process/submitting-drivers.rst にも目を通してください。
-------------------------------------------- --------------------------------------------
セクション1 パッチの作り方と送り方 セクション1 パッチの作り方と送り方
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment