Skip to content

Commit 8815da9

Browse files
committed
Merge tag 'docs-6.10' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "Another not-too-busy cycle for documentation, including: - Some build-system changes to detect the variable fonts installed by some distributions that can break the PDF build. - Various updates and additions to the Spanish, Chinese, Italian, and Japanese translations. - Update the stable-kernel rules to match modern practice ... and the usual array of corrections, updates, and typo fixes" * tag 'docs-6.10' of git://git.lwn.net/linux: (42 commits) cgroup: Add documentation for missing zswap memory.stat kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning. docs:core-api: fixed typos and grammar in printk-index page Documentation: tracing: Fix spelling mistakes docs/zh_CN/rust: Update the translation of quick-start to 6.9-rc4 docs/zh_CN/rust: Update the translation of general-information to 6.9-rc4 docs/zh_CN/rust: Update the translation of coding-guidelines to 6.9-rc4 docs/zh_CN/rust: Update the translation of arch-support to 6.9-rc4 docs: stable-kernel-rules: fix typo sent->send docs/zh_CN: remove two inconsistent spaces docs: scripts/check-variable-fonts.sh: Improve commands for detection docs: stable-kernel-rules: create special tag to flag 'no backporting' docs: stable-kernel-rules: explain use of stable@kernel.org (w/o @Vger.) docs: stable-kernel-rules: remove code-labels tags and a indention level docs: stable-kernel-rules: call mainline by its name and change example docs: stable-kernel-rules: reduce redundancy docs, kprobes: Add riscv as supported architecture Docs: typos/spelling docs: kernel_include.py: Cope with docutils 0.21 docs: ja_JP/howto: Catch up update in v6.8 ...
2 parents 25c7364 + db5b4f3 commit 8815da9

File tree

88 files changed

+2299
-274
lines changed

Some content is hidden

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

88 files changed

+2299
-274
lines changed

.mailmap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ Bryan Tan <bryan-bt.tan@broadcom.com> <bryantan@vmware.com>
133133
Cai Huoqing <cai.huoqing@linux.dev> <caihuoqing@baidu.com>
134134
Can Guo <quic_cang@quicinc.com> <cang@codeaurora.org>
135135
Carl Huang <quic_cjhuang@quicinc.com> <cjhuang@codeaurora.org>
136+
Carlos Bilbao <carlos.bilbao.osdev@gmail.com> <carlos.bilbao@amd.com>
136137
Changbin Du <changbin.du@intel.com> <changbin.du@gmail.com>
137138
Changbin Du <changbin.du@intel.com> <changbin.du@intel.com>
138139
Chao Yu <chao@kernel.org> <chao2.yu@samsung.com>

Documentation/Makefile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ BUILDDIR = $(obj)/output
2828
PDFLATEX = xelatex
2929
LATEXOPTS = -interaction=batchmode -no-shell-escape
3030

31+
# For denylisting "variable font" files
32+
# Can be overridden by setting as an env variable
33+
FONTS_CONF_DENY_VF ?= $(HOME)/deny-vf
34+
3135
ifeq ($(findstring 1, $(KBUILD_VERBOSE)),)
3236
SPHINXOPTS += "-q"
3337
endif
@@ -151,10 +155,11 @@ pdfdocs:
151155

152156
else # HAVE_PDFLATEX
153157

158+
pdfdocs: DENY_VF = XDG_CONFIG_HOME=$(FONTS_CONF_DENY_VF)
154159
pdfdocs: latexdocs
155160
@$(srctree)/scripts/sphinx-pre-install --version-check
156161
$(foreach var,$(SPHINXDIRS), \
157-
$(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit; \
162+
$(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" $(DENY_VF) -C $(BUILDDIR)/$(var)/latex || sh $(srctree)/scripts/check-variable-fonts.sh || exit; \
158163
mkdir -p $(BUILDDIR)/$(var)/pdf; \
159164
mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \
160165
)

Documentation/admin-guide/cgroup-v2.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1572,6 +1572,15 @@ PAGE_SIZE multiple when read back.
15721572
pglazyfreed (npn)
15731573
Amount of reclaimed lazyfree pages
15741574

1575+
zswpin
1576+
Number of pages moved in to memory from zswap.
1577+
1578+
zswpout
1579+
Number of pages moved out of memory to zswap.
1580+
1581+
zswpwb
1582+
Number of pages written from zswap to swap.
1583+
15751584
thp_fault_alloc (npn)
15761585
Number of transparent hugepages which were allocated to satisfy
15771586
a page fault. This counter is not present when CONFIG_TRANSPARENT_HUGEPAGE

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ arg4:
6767
will be performed for all tasks in the task group of ``pid``.
6868

6969
arg5:
70-
userspace pointer to an unsigned long for storing the cookie returned by
71-
``PR_SCHED_CORE_GET`` command. Should be 0 for all other commands.
70+
userspace pointer to an unsigned long long for storing the cookie returned
71+
by ``PR_SCHED_CORE_GET`` command. Should be 0 for all other commands.
7272

7373
In order for a process to push a cookie to, or pull a cookie from a process, it
7474
is required to have the ptrace access mode: `PTRACE_MODE_READ_REALCREDS` to the

Documentation/admin-guide/hw-vuln/srso.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ and does not want to suffer the performance impact, one can always
135135
disable the mitigation with spec_rstack_overflow=off.
136136

137137
Similarly, 'Mitigation: IBPB' is another full mitigation type employing
138-
an indrect branch prediction barrier after having applied the required
138+
an indirect branch prediction barrier after having applied the required
139139
microcode patch for one's system. This mitigation comes also at
140140
a performance cost.
141141

Documentation/admin-guide/kernel-parameters.txt

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4173,13 +4173,11 @@
41734173

41744174
page_alloc.shuffle=
41754175
[KNL] Boolean flag to control whether the page allocator
4176-
should randomize its free lists. The randomization may
4177-
be automatically enabled if the kernel detects it is
4178-
running on a platform with a direct-mapped memory-side
4179-
cache, and this parameter can be used to
4180-
override/disable that behavior. The state of the flag
4181-
can be read from sysfs at:
4176+
should randomize its free lists. This parameter can be
4177+
used to enable/disable page randomization. The state of
4178+
the flag can be read from sysfs at:
41824179
/sys/module/page_alloc/parameters/shuffle.
4180+
This parameter is only available if CONFIG_SHUFFLE_PAGE_ALLOCATOR=y.
41834181

41844182
page_owner= [KNL,EARLY] Boot-time page_owner enabling option.
41854183
Storage of the information about who allocated
@@ -7353,7 +7351,7 @@
73537351
This can be changed after boot by writing to the
73547352
matching /sys/module/workqueue/parameters file. All
73557353
workqueues with the "default" affinity scope will be
7356-
updated accordignly.
7354+
updated accordingly.
73577355

73587356
workqueue.debug_force_rr_cpu
73597357
Workqueue used to implicitly guarantee that work

Documentation/admin-guide/mm/ksm.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ limited by the ``advisor_max_cpu`` parameter. In addition there is also the
308308
``advisor_target_scan_time`` parameter. This parameter sets the target time to
309309
scan all the KSM candidate pages. The parameter ``advisor_target_scan_time``
310310
decides how aggressive the scan time advisor scans candidate pages. Lower
311-
values make the scan time advisor to scan more aggresively. This is the most
311+
values make the scan time advisor to scan more aggressively. This is the most
312312
important parameter for the configuration of the scan time advisor.
313313

314314
The initial value and the maximum value can be changed with

Documentation/admin-guide/reporting-regressions.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ The important basics
4242
--------------------
4343

4444

45-
What is a "regression" and what is the "no regressions rule"?
45+
What is a "regression" and what is the "no regressions" rule?
4646
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4747

4848
It's a regression if some application or practical use case running fine with
4949
one Linux kernel works worse or not at all with a newer version compiled using a
50-
similar configuration. The "no regressions rule" forbids this to take place; if
50+
similar configuration. The "no regressions" rule forbids this to take place; if
5151
it happens by accident, developers that caused it are expected to quickly fix
5252
the issue.
5353

@@ -173,7 +173,7 @@ Additional details about regressions
173173
------------------------------------
174174

175175

176-
What is the goal of the "no regressions rule"?
176+
What is the goal of the "no regressions" rule?
177177
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
178178

179179
Users should feel safe when updating kernel versions and not have to worry
@@ -199,8 +199,8 @@ Exceptions to this rule are extremely rare; in the past developers almost always
199199
turned out to be wrong when they assumed a particular situation was warranting
200200
an exception.
201201

202-
Who ensures the "no regressions" is actually followed?
203-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202+
Who ensures the "no regressions" rule is actually followed?
203+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
204204

205205
The subsystem maintainers should take care of that, which are watched and
206206
supported by the tree maintainers -- e.g. Linus Torvalds for mainline and

Documentation/arch/m68k/buddha-driver.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ When accessing IDE registers with A6=1 (for example $84x),
173173
the timing will always be mode 0 8-bit compatible, no matter
174174
what you have selected in the speed register:
175175

176-
781ns select, IOR/IOW after 4 clock cycles (=314ns) aktive.
176+
781ns select, IOR/IOW after 4 clock cycles (=314ns) active.
177177

178178
All the timings with a very short select-signal (the 355ns
179179
fast accesses) depend on the accelerator card used in the

Documentation/arch/sparc/oradax/dax-hv-api.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Chapter 36. Coprocessor services
4141
submissions until they succeed; waiting for an outstanding CCB to complete is not necessary, and would
4242
not be a guarantee that a future submission would succeed.
4343

44-
The availablility of DAX coprocessor command service is indicated by the presence of the DAX virtual
44+
The availability of DAX coprocessor command service is indicated by the presence of the DAX virtual
4545
device node in the guest MD (Section 8.24.17, “Database Analytics Accelerators (DAX) virtual-device
4646
node”).
4747

0 commit comments

Comments
 (0)