Skip to content

Commit aad26f5

Browse files
committed
Merge tag 'docs-6.0' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "This was a moderately busy cycle for documentation, but nothing all that earth-shaking: - More Chinese translations, and an update to the Italian translations. The Japanese, Korean, and traditional Chinese translations are more-or-less unmaintained at this point, instead. - Some build-system performance improvements. - The removal of the archaic submitting-drivers.rst document, with the movement of what useful material that remained into other docs. - Improvements to sphinx-pre-install to, hopefully, give more useful suggestions. - A number of build-warning fixes Plus the usual collection of typo fixes, updates, and more" * tag 'docs-6.0' of git://git.lwn.net/linux: (92 commits) docs: efi-stub: Fix paths for x86 / arm stubs Docs/zh_CN: Update the translation of sched-stats to 5.19-rc8 Docs/zh_CN: Update the translation of pci to 5.19-rc8 Docs/zh_CN: Update the translation of pci-iov-howto to 5.19-rc8 Docs/zh_CN: Update the translation of usage to 5.19-rc8 Docs/zh_CN: Update the translation of testing-overview to 5.19-rc8 Docs/zh_CN: Update the translation of sparse to 5.19-rc8 Docs/zh_CN: Update the translation of kasan to 5.19-rc8 Docs/zh_CN: Update the translation of iio_configfs to 5.19-rc8 doc:it_IT: align Italian documentation docs: Remove spurious tag from admin-guide/mm/overcommit-accounting.rst Documentation: process: Update email client instructions for Thunderbird docs: ABI: correct QEMU fw_cfg spec path doc/zh_CN: remove submitting-driver reference from docs docs: zh_TW: align to submitting-drivers removal docs: zh_CN: align to submitting-drivers removal docs: ko_KR: howto: remove reference to removed submitting-drivers docs: ja_JP: howto: remove reference to removed submitting-drivers docs: it_IT: align to submitting-drivers removal docs: process: remove outdated submitting-drivers.rst ...
2 parents b069122 + 339170d commit aad26f5

133 files changed

Lines changed: 3274 additions & 1400 deletions

File tree

Some content is hidden

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

Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ Description:
1212
configuration data to the guest userspace.
1313

1414
The authoritative guest-side hardware interface documentation
15-
to the fw_cfg device can be found in "docs/specs/fw_cfg.txt"
16-
in the QEMU source tree.
15+
to the fw_cfg device can be found in "docs/specs/fw_cfg.rst"
16+
in the QEMU source tree, or online at:
17+
https://qemu-project.gitlab.io/qemu/specs/fw_cfg.html
1718

1819
**SysFS fw_cfg Interface**
1920

Documentation/Kconfig

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
11
config WARN_MISSING_DOCUMENTS
2-
32
bool "Warn if there's a missing documentation file"
43
depends on COMPILE_TEST
54
help
6-
It is not uncommon that a document gets renamed.
7-
This option makes the Kernel to check for missing dependencies,
8-
warning when something is missing. Works only if the Kernel
9-
is built from a git tree.
5+
It is not uncommon that a document gets renamed.
6+
This option makes the Kernel to check for missing dependencies,
7+
warning when something is missing. Works only if the Kernel
8+
is built from a git tree.
109

11-
If unsure, select 'N'.
10+
If unsure, select 'N'.
1211

1312
config WARN_ABI_ERRORS
1413
bool "Warn if there are errors at ABI files"
1514
depends on COMPILE_TEST
1615
help
17-
The files under Documentation/ABI should follow what's
18-
described at Documentation/ABI/README. Yet, as they're manually
19-
written, it would be possible that some of those files would
20-
have errors that would break them for being parsed by
21-
scripts/get_abi.pl. Add a check to verify them.
16+
The files under Documentation/ABI should follow what's
17+
described at Documentation/ABI/README. Yet, as they're manually
18+
written, it would be possible that some of those files would
19+
have errors that would break them for being parsed by
20+
scripts/get_abi.pl. Add a check to verify them.
2221

23-
If unsure, select 'N'.
22+
If unsure, select 'N'.

Documentation/admin-guide/devices.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@ This list is the Linux Device List, the official registry of allocated
77
device numbers and ``/dev`` directory nodes for the Linux operating
88
system.
99

10-
The LaTeX version of this document is no longer maintained, nor is
11-
the document that used to reside at lanana.org. This version in the
12-
mainline Linux kernel is the master document. Updates shall be sent
13-
as patches to the kernel maintainers (see the
10+
The version of this document at lanana.org is no longer maintained. This
11+
version in the mainline Linux kernel is the master document. Updates
12+
shall be sent as patches to the kernel maintainers (see the
1413
:ref:`Documentation/process/submitting-patches.rst <submittingpatches>` document).
1514
Specifically explore the sections titled "CHAR and MISC DRIVERS", and
1615
"BLOCK LAYER" in the MAINTAINERS file to find the right maintainers

Documentation/admin-guide/efi-stub.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ as a PE/COFF image, thereby convincing EFI firmware loaders to load
77
it as an EFI executable. The code that modifies the bzImage header,
88
along with the EFI-specific entry point that the firmware loader
99
jumps to are collectively known as the "EFI boot stub", and live in
10-
arch/x86/boot/header.S and arch/x86/boot/compressed/eboot.c,
10+
arch/x86/boot/header.S and drivers/firmware/efi/libstub/x86-stub.c,
1111
respectively. For ARM the EFI stub is implemented in
1212
arch/arm/boot/compressed/efi-header.S and
13-
arch/arm/boot/compressed/efi-stub.c. EFI stub code that is shared
13+
drivers/firmware/efi/libstub/arm32-stub.c. EFI stub code that is shared
1414
between architectures is in drivers/firmware/efi/libstub.
1515

1616
For arm64, there is no compressed kernel support, so the Image itself

Documentation/admin-guide/kernel-parameters.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3109,7 +3109,7 @@
31093109
mem_encrypt=on: Activate SME
31103110
mem_encrypt=off: Do not activate SME
31113111

3112-
Refer to Documentation/virt/kvm/amd-memory-encryption.rst
3112+
Refer to Documentation/virt/kvm/x86/amd-memory-encryption.rst
31133113
for details on when memory encryption can be activated.
31143114

31153115
mem_sleep_default= [SUSPEND] Default system suspend mode:

Documentation/admin-guide/sysctl/kernel.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ acct
3838

3939
If BSD-style process accounting is enabled these values control
4040
its behaviour. If free space on filesystem where the log lives
41-
goes below ``lowwater``% accounting suspends. If free space gets
42-
above ``highwater``% accounting resumes. ``frequency`` determines
41+
goes below ``lowwater``\ % accounting suspends. If free space gets
42+
above ``highwater``\ % accounting resumes. ``frequency`` determines
4343
how often do we check the amount of free space (value is in
4444
seconds). Default:
4545

Documentation/arm64/elf_hwcaps.rst

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -171,96 +171,73 @@ HWCAP_PACG
171171
Documentation/arm64/pointer-authentication.rst.
172172

173173
HWCAP2_DCPODP
174-
175174
Functionality implied by ID_AA64ISAR1_EL1.DPB == 0b0010.
176175

177176
HWCAP2_SVE2
178-
179177
Functionality implied by ID_AA64ZFR0_EL1.SVEVer == 0b0001.
180178

181179
HWCAP2_SVEAES
182-
183180
Functionality implied by ID_AA64ZFR0_EL1.AES == 0b0001.
184181

185182
HWCAP2_SVEPMULL
186-
187183
Functionality implied by ID_AA64ZFR0_EL1.AES == 0b0010.
188184

189185
HWCAP2_SVEBITPERM
190-
191186
Functionality implied by ID_AA64ZFR0_EL1.BitPerm == 0b0001.
192187

193188
HWCAP2_SVESHA3
194-
195189
Functionality implied by ID_AA64ZFR0_EL1.SHA3 == 0b0001.
196190

197191
HWCAP2_SVESM4
198-
199192
Functionality implied by ID_AA64ZFR0_EL1.SM4 == 0b0001.
200193

201194
HWCAP2_FLAGM2
202-
203195
Functionality implied by ID_AA64ISAR0_EL1.TS == 0b0010.
204196

205197
HWCAP2_FRINT
206-
207198
Functionality implied by ID_AA64ISAR1_EL1.FRINTTS == 0b0001.
208199

209200
HWCAP2_SVEI8MM
210-
211201
Functionality implied by ID_AA64ZFR0_EL1.I8MM == 0b0001.
212202

213203
HWCAP2_SVEF32MM
214-
215204
Functionality implied by ID_AA64ZFR0_EL1.F32MM == 0b0001.
216205

217206
HWCAP2_SVEF64MM
218-
219207
Functionality implied by ID_AA64ZFR0_EL1.F64MM == 0b0001.
220208

221209
HWCAP2_SVEBF16
222-
223210
Functionality implied by ID_AA64ZFR0_EL1.BF16 == 0b0001.
224211

225212
HWCAP2_I8MM
226-
227213
Functionality implied by ID_AA64ISAR1_EL1.I8MM == 0b0001.
228214

229215
HWCAP2_BF16
230-
231216
Functionality implied by ID_AA64ISAR1_EL1.BF16 == 0b0001.
232217

233218
HWCAP2_DGH
234-
235219
Functionality implied by ID_AA64ISAR1_EL1.DGH == 0b0001.
236220

237221
HWCAP2_RNG
238-
239222
Functionality implied by ID_AA64ISAR0_EL1.RNDR == 0b0001.
240223

241224
HWCAP2_BTI
242-
243225
Functionality implied by ID_AA64PFR0_EL1.BT == 0b0001.
244226

245227
HWCAP2_MTE
246-
247228
Functionality implied by ID_AA64PFR1_EL1.MTE == 0b0010, as described
248229
by Documentation/arm64/memory-tagging-extension.rst.
249230

250231
HWCAP2_ECV
251-
252232
Functionality implied by ID_AA64MMFR0_EL1.ECV == 0b0001.
253233

254234
HWCAP2_AFP
255-
256235
Functionality implied by ID_AA64MFR1_EL1.AFP == 0b0001.
257236

258237
HWCAP2_RPRES
259-
260238
Functionality implied by ID_AA64ISAR2_EL1.RPRES == 0b0001.
261239

262240
HWCAP2_MTE3
263-
264241
Functionality implied by ID_AA64PFR1_EL1.MTE == 0b0011, as described
265242
by Documentation/arm64/memory-tagging-extension.rst.
266243

Documentation/dev-tools/coccinelle.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The wiki documentation always refers to the linux-next version of the script.
6666

6767
For Semantic Patch Language(SmPL) grammar documentation refer to:
6868

69-
http://coccinelle.lip6.fr/documentation.php
69+
https://coccinelle.gitlabpages.inria.fr/website/docs/main_grammar.html
7070

7171
Using Coccinelle on the Linux kernel
7272
------------------------------------

Documentation/dev-tools/kselftest.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,14 @@ In general, the rules for selftests are
208208
Contributing new tests (details)
209209
================================
210210

211+
* In your Makefile, use facilities from lib.mk by including it instead of
212+
reinventing the wheel. Specify flags and binaries generation flags on
213+
need basis before including lib.mk. ::
214+
215+
CFLAGS = $(KHDR_INCLUDES)
216+
TEST_GEN_PROGS := close_range_test
217+
include ../lib.mk
218+
211219
* Use TEST_GEN_XXX if such binaries or files are generated during
212220
compiling.
213221

@@ -230,13 +238,30 @@ Contributing new tests (details)
230238
* First use the headers inside the kernel source and/or git repo, and then the
231239
system headers. Headers for the kernel release as opposed to headers
232240
installed by the distro on the system should be the primary focus to be able
233-
to find regressions.
241+
to find regressions. Use KHDR_INCLUDES in Makefile to include headers from
242+
the kernel source.
234243

235244
* If a test needs specific kernel config options enabled, add a config file in
236245
the test directory to enable them.
237246

238247
e.g: tools/testing/selftests/android/config
239248

249+
* Create a .gitignore file inside test directory and add all generated objects
250+
in it.
251+
252+
* Add new test name in TARGETS in selftests/Makefile::
253+
254+
TARGETS += android
255+
256+
* All changes should pass::
257+
258+
kselftest-{all,install,clean,gen_tar}
259+
kselftest-{all,install,clean,gen_tar} O=abo_path
260+
kselftest-{all,install,clean,gen_tar} O=rel_path
261+
make -C tools/testing/selftests {all,install,clean,gen_tar}
262+
make -C tools/testing/selftests {all,install,clean,gen_tar} O=abs_path
263+
make -C tools/testing/selftests {all,install,clean,gen_tar} O=rel_path
264+
240265
Test Module
241266
===========
242267

Documentation/devicetree/bindings/input/da9062-onkey.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This module is part of the DA9061/DA9062/DA9063. For more details about entire
44
DA9062 and DA9061 chips see Documentation/devicetree/bindings/mfd/da9062.txt
5-
For DA9063 see Documentation/devicetree/bindings/mfd/da9063.txt
5+
For DA9063 see Documentation/devicetree/bindings/mfd/dlg,da9063.yaml
66

77
This module provides the KEY_POWER event.
88

0 commit comments

Comments
 (0)