A handful of late-arriving documentation fixes.
-----BEGIN PGP SIGNATURE----- iQFDBAABCAAtFiEEIw+MvkEiF49krdp9F0NaE2wMflgFAmWoABAPHGNvcmJldEBs d24ubmV0AAoJEBdDWhNsDH5Y+yAH/2YPZFKa+QzzYE6xbQnjPErPnGl5Ubdaem3q PODmp5DdIqnVRz8eEHY0h4Y9676RCzXg8aH6H+C5zkKJSof/Z7KKpQjmWTBnr30z QUXgcyxG+rTdZezZG8PKZVhZl7j8YX5ln3i4zR4g0MeaFpxiROrfX22jrnT2fqG4 qkoenoZPwCZsrRP4qo7kDKPyfV8yupgjJ8uDcua7e5/5lSGT5siGVitVD13lcMXo bO/Tdhr2w09S898nZJSEZIP8SvTA1Rjhd0xmHRSaiNjQV/qMU5ZAtaukuBkQGJpY FYP4enQGefBk2hJ92gm5yg0Dv8GSeC3i0aKjhomrvnpu4cVvhxc= =DxUH -----END PGP SIGNATURE----- Merge tag 'docs-6.8-2' of git://git.lwn.net/linux Pull documentation fixes from Jonathan Corbet: "A handful of late-arriving documentation fixes" * tag 'docs-6.8-2' of git://git.lwn.net/linux: docs, kprobes: Add loongarch as supported architecture docs, kprobes: Update email address of Masami Hiramatsu docs: admin-guide: hw_random: update rng-tools website Documentation/core-api: fix spelling mistake in workqueue docs: kernel_feat.py: fix potential command injection Documentation: constrain alabaster package to older versions
This commit is contained in:
commit
1b1934dbbd
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features
|
.. kernel-feat:: features
|
||||||
|
|
|
@ -14,10 +14,9 @@ into that core.
|
||||||
|
|
||||||
To make the most effective use of these mechanisms, you
|
To make the most effective use of these mechanisms, you
|
||||||
should download the support software as well. Download the
|
should download the support software as well. Download the
|
||||||
latest version of the "rng-tools" package from the
|
latest version of the "rng-tools" package from:
|
||||||
hw_random driver's official Web site:
|
|
||||||
|
|
||||||
http://sourceforge.net/projects/gkernel/
|
https://github.com/nhorman/rng-tools
|
||||||
|
|
||||||
Those tools use /dev/hwrng to fill the kernel entropy pool,
|
Those tools use /dev/hwrng to fill the kernel entropy pool,
|
||||||
which is used internally and exported by the /dev/urandom and
|
which is used internally and exported by the /dev/urandom and
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features arc
|
.. kernel-feat:: features arc
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features arm
|
.. kernel-feat:: features arm
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features arm64
|
.. kernel-feat:: features arm64
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features loongarch
|
.. kernel-feat:: features loongarch
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features m68k
|
.. kernel-feat:: features m68k
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features mips
|
.. kernel-feat:: features mips
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features nios2
|
.. kernel-feat:: features nios2
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features openrisc
|
.. kernel-feat:: features openrisc
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features parisc
|
.. kernel-feat:: features parisc
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features powerpc
|
.. kernel-feat:: features powerpc
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features riscv
|
.. kernel-feat:: features riscv
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features s390
|
.. kernel-feat:: features s390
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features sh
|
.. kernel-feat:: features sh
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features sparc
|
.. kernel-feat:: features sparc
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features x86
|
.. kernel-feat:: features x86
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. SPDX-License-Identifier: GPL-2.0
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features xtensa
|
.. kernel-feat:: features xtensa
|
||||||
|
|
|
@ -446,7 +446,7 @@ The command used: ::
|
||||||
|
|
||||||
There are 24 issuers, each issuing 64 IOs concurrently. ``--verify=sha512``
|
There are 24 issuers, each issuing 64 IOs concurrently. ``--verify=sha512``
|
||||||
makes ``fio`` generate and read back the content each time which makes
|
makes ``fio`` generate and read back the content each time which makes
|
||||||
execution locality matter between the issuer and ``kcryptd``. The followings
|
execution locality matter between the issuer and ``kcryptd``. The following
|
||||||
are the read bandwidths and CPU utilizations depending on different affinity
|
are the read bandwidths and CPU utilizations depending on different affinity
|
||||||
scope settings on ``kcryptd`` measured over five runs. Bandwidths are in
|
scope settings on ``kcryptd`` measured over five runs. Bandwidths are in
|
||||||
MiBps, and CPU util in percents.
|
MiBps, and CPU util in percents.
|
||||||
|
|
|
@ -37,8 +37,6 @@ import re
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from os import path
|
|
||||||
|
|
||||||
from docutils import nodes, statemachine
|
from docutils import nodes, statemachine
|
||||||
from docutils.statemachine import ViewList
|
from docutils.statemachine import ViewList
|
||||||
from docutils.parsers.rst import directives, Directive
|
from docutils.parsers.rst import directives, Directive
|
||||||
|
@ -76,33 +74,26 @@ class KernelFeat(Directive):
|
||||||
self.state.document.settings.env.app.warn(message, prefix="")
|
self.state.document.settings.env.app.warn(message, prefix="")
|
||||||
|
|
||||||
def run(self):
|
def run(self):
|
||||||
|
|
||||||
doc = self.state.document
|
doc = self.state.document
|
||||||
if not doc.settings.file_insertion_enabled:
|
if not doc.settings.file_insertion_enabled:
|
||||||
raise self.warning("docutils: file insertion disabled")
|
raise self.warning("docutils: file insertion disabled")
|
||||||
|
|
||||||
env = doc.settings.env
|
env = doc.settings.env
|
||||||
cwd = path.dirname(doc.current_source)
|
|
||||||
cmd = "get_feat.pl rest --enable-fname --dir "
|
srctree = os.path.abspath(os.environ["srctree"])
|
||||||
cmd += self.arguments[0]
|
|
||||||
|
args = [
|
||||||
|
os.path.join(srctree, 'scripts/get_feat.pl'),
|
||||||
|
'rest',
|
||||||
|
'--enable-fname',
|
||||||
|
'--dir',
|
||||||
|
os.path.join(srctree, 'Documentation', self.arguments[0]),
|
||||||
|
]
|
||||||
|
|
||||||
if len(self.arguments) > 1:
|
if len(self.arguments) > 1:
|
||||||
cmd += " --arch " + self.arguments[1]
|
args.extend(['--arch', self.arguments[1]])
|
||||||
|
|
||||||
srctree = path.abspath(os.environ["srctree"])
|
lines = subprocess.check_output(args, cwd=os.path.dirname(doc.current_source)).decode('utf-8')
|
||||||
|
|
||||||
fname = cmd
|
|
||||||
|
|
||||||
# extend PATH with $(srctree)/scripts
|
|
||||||
path_env = os.pathsep.join([
|
|
||||||
srctree + os.sep + "scripts",
|
|
||||||
os.environ["PATH"]
|
|
||||||
])
|
|
||||||
shell_env = os.environ.copy()
|
|
||||||
shell_env["PATH"] = path_env
|
|
||||||
shell_env["srctree"] = srctree
|
|
||||||
|
|
||||||
lines = self.runCmd(cmd, shell=True, cwd=cwd, env=shell_env)
|
|
||||||
|
|
||||||
line_regex = re.compile(r"^\.\. FILE (\S+)$")
|
line_regex = re.compile(r"^\.\. FILE (\S+)$")
|
||||||
|
|
||||||
|
@ -121,30 +112,6 @@ class KernelFeat(Directive):
|
||||||
nodeList = self.nestedParse(out_lines, fname)
|
nodeList = self.nestedParse(out_lines, fname)
|
||||||
return nodeList
|
return nodeList
|
||||||
|
|
||||||
def runCmd(self, cmd, **kwargs):
|
|
||||||
u"""Run command ``cmd`` and return its stdout as unicode."""
|
|
||||||
|
|
||||||
try:
|
|
||||||
proc = subprocess.Popen(
|
|
||||||
cmd
|
|
||||||
, stdout = subprocess.PIPE
|
|
||||||
, stderr = subprocess.PIPE
|
|
||||||
, **kwargs
|
|
||||||
)
|
|
||||||
out, err = proc.communicate()
|
|
||||||
|
|
||||||
out, err = codecs.decode(out, 'utf-8'), codecs.decode(err, 'utf-8')
|
|
||||||
|
|
||||||
if proc.returncode != 0:
|
|
||||||
raise self.severe(
|
|
||||||
u"command '%s' failed with return code %d"
|
|
||||||
% (cmd, proc.returncode)
|
|
||||||
)
|
|
||||||
except OSError as exc:
|
|
||||||
raise self.severe(u"problems with '%s' directive: %s."
|
|
||||||
% (self.name, ErrorString(exc)))
|
|
||||||
return out
|
|
||||||
|
|
||||||
def nestedParse(self, lines, fname):
|
def nestedParse(self, lines, fname):
|
||||||
content = ViewList()
|
content = ViewList()
|
||||||
node = nodes.section()
|
node = nodes.section()
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
# jinja2>=3.1 is not compatible with Sphinx<4.0
|
# jinja2>=3.1 is not compatible with Sphinx<4.0
|
||||||
jinja2<3.1
|
jinja2<3.1
|
||||||
|
# alabaster>=0.7.14 is not compatible with Sphinx<=3.3
|
||||||
|
alabaster<0.7.14
|
||||||
Sphinx==2.4.4
|
Sphinx==2.4.4
|
||||||
pyyaml
|
pyyaml
|
||||||
|
|
|
@ -4,7 +4,7 @@ Kernel Probes (Kprobes)
|
||||||
|
|
||||||
:Author: Jim Keniston <jkenisto@us.ibm.com>
|
:Author: Jim Keniston <jkenisto@us.ibm.com>
|
||||||
:Author: Prasanna S Panchamukhi <prasanna.panchamukhi@gmail.com>
|
:Author: Prasanna S Panchamukhi <prasanna.panchamukhi@gmail.com>
|
||||||
:Author: Masami Hiramatsu <mhiramat@redhat.com>
|
:Author: Masami Hiramatsu <mhiramat@kernel.org>
|
||||||
|
|
||||||
.. CONTENTS
|
.. CONTENTS
|
||||||
|
|
||||||
|
@ -321,6 +321,7 @@ architectures:
|
||||||
- mips
|
- mips
|
||||||
- s390
|
- s390
|
||||||
- parisc
|
- parisc
|
||||||
|
- loongarch
|
||||||
|
|
||||||
Configuring Kprobes
|
Configuring Kprobes
|
||||||
===================
|
===================
|
||||||
|
|
|
@ -5,4 +5,4 @@
|
||||||
:Original: Documentation/arch/loongarch/features.rst
|
:Original: Documentation/arch/loongarch/features.rst
|
||||||
:Translator: Huacai Chen <chenhuacai@loongson.cn>
|
:Translator: Huacai Chen <chenhuacai@loongson.cn>
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features loongarch
|
.. kernel-feat:: features loongarch
|
||||||
|
|
|
@ -10,4 +10,4 @@
|
||||||
|
|
||||||
.. _cn_features:
|
.. _cn_features:
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features mips
|
.. kernel-feat:: features mips
|
||||||
|
|
|
@ -5,5 +5,5 @@
|
||||||
:Original: Documentation/arch/loongarch/features.rst
|
:Original: Documentation/arch/loongarch/features.rst
|
||||||
:Translator: Huacai Chen <chenhuacai@loongson.cn>
|
:Translator: Huacai Chen <chenhuacai@loongson.cn>
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features loongarch
|
.. kernel-feat:: features loongarch
|
||||||
|
|
||||||
|
|
|
@ -10,5 +10,5 @@
|
||||||
|
|
||||||
.. _tw_features:
|
.. _tw_features:
|
||||||
|
|
||||||
.. kernel-feat:: $srctree/Documentation/features mips
|
.. kernel-feat:: features mips
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue