Skip to content

Commit 5b9b416

Browse files
torvaldstorvalds
committed
Merge tag 'docs-6.8' of git://git.lwn.net/linux
Pull documentation update from Jonathan Corbet: "Another moderately busy cycle for documentation, including: - The minimum Sphinx requirement has been raised to 2.4.4, following a warning that was added in 6.2 - Some reworking of the Documentation/process front page to, hopefully, make it more useful - Various kernel-doc tweaks to, for example, make it deal properly with __counted_by annotations - We have also restored a warning for documentation of nonexistent structure members that disappeared a while back. That had the delightful consequence of adding some 600 warnings to the docs build. A sustained effort by Randy, Vegard, and myself has addressed almost all of those, bringing the documentation back into sync with the code. The fixes are going through the appropriate maintainer trees - Various improvements to the HTML rendered docs, including automatic links to Git revisions and a nice new pulldown to make translations easy to access - Speaking of translations, more of those for Spanish and Chinese ... plus the usual stream of documentation updates and typo fixes" * tag 'docs-6.8' of git://git.lwn.net/linux: (57 commits) MAINTAINERS: use tabs for indent of CONFIDENTIAL COMPUTING THREAT MODEL A reworked process/index.rst ring-buffer/Documentation: Add documentation on buffer_percent file Translated the RISC-V architecture boot documentation. Docs: remove mentions of fdformat from util-linux Docs/zh_CN: Fix the meaning of DEBUG to pr_debug() Documentation: move driver-api/dcdbas to userspace-api/ Documentation: move driver-api/isapnp to userspace-api/ Documentation/core-api : fix typo in workqueue Documentation/trace: Fixed typos in the ftrace FLAGS section kernel-doc: handle a void function without producing a warning scripts/get_abi.pl: ignore some temp files docs: kernel_abi.py: fix command injection scripts/get_abi: fix source path leak CREDITS, MAINTAINERS, docs/process/howto: Update man-pages' maintainer docs: translations: add translations links when they exist kernel-doc: Align quick help and the code MAINTAINERS: add reviewer for Spanish translations docs: ignore __counted_by attribute in structure definitions scripts: kernel-doc: Clarify missing struct member description ..
2 parents 22d29f1 + 2d179e8 commit 5b9b416

153 files changed

Lines changed: 3206 additions & 794 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.

‎CREDITS‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1835,6 +1835,13 @@ S: K osmidomkum 723
18351835
S: 160 00 Praha 6
18361836
S: Czech Republic
18371837

1838+
N: Michael Kerrisk
1839+
E: mtk.manpages@gmail.com
1840+
W: https://man7.org/
1841+
P: 4096R/3A35CE5E E522 595B 52ED A4E6 BFCC CB5E 8561 9911 3A35 CE5E
1842+
D: Maintainer of the Linux man-pages project
1843+
D: Linux man pages online, at <https://man7.org/linux/man-pages/>
1844+
18381845
N: Niels Kristian Bech Jensen
18391846
E: nkbj1970@hotmail.com
18401847
D: Miscellaneous kernel updates and fixes.

‎Documentation/admin-guide/abi-obsolete.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ marked to be removed at some later point in time.
77
The description of the interface will document the reason why it is
88
obsolete and when it can be expected to be removed.
99

10-
.. kernel-abi:: $srctree/Documentation/ABI/obsolete
10+
.. kernel-abi:: ABI/obsolete
1111
:rst:

‎Documentation/admin-guide/abi-removed.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
ABI removed symbols
22
===================
33

4-
.. kernel-abi:: $srctree/Documentation/ABI/removed
4+
.. kernel-abi:: ABI/removed
55
:rst:

‎Documentation/admin-guide/abi-stable.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ for at least 2 years.
1010
Most interfaces (like syscalls) are expected to never change and always
1111
be available.
1212

13-
.. kernel-abi:: $srctree/Documentation/ABI/stable
13+
.. kernel-abi:: ABI/stable
1414
:rst:

‎Documentation/admin-guide/abi-testing.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ Programs that use these interfaces are strongly encouraged to add their
1616
name to the description of these interfaces, so that the kernel
1717
developers can easily notify them if any changes occur.
1818

19-
.. kernel-abi:: $srctree/Documentation/ABI/testing
19+
.. kernel-abi:: ABI/testing
2020
:rst:

‎Documentation/admin-guide/dynamic-debug-howto.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -321,13 +321,13 @@ Examples
321321
:#> ddcmd 'format "nfsd: READ" +p'
322322

323323
// enable messages in files of which the paths include string "usb"
324-
:#> ddcmd 'file *usb* +p' > /proc/dynamic_debug/control
324+
:#> ddcmd 'file *usb* +p'
325325

326326
// enable all messages
327-
:#> ddcmd '+p' > /proc/dynamic_debug/control
327+
:#> ddcmd '+p'
328328

329329
// add module, function to all enabled messages
330-
:#> ddcmd '+mf' > /proc/dynamic_debug/control
330+
:#> ddcmd '+mf'
331331

332332
// boot-args example, with newlines and comments for readability
333333
Kernel command line: ...

‎Documentation/admin-guide/kernel-parameters.txt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
accept_memory= [MM]
2+
Format: { eager | lazy }
3+
default: lazy
4+
By default, unaccepted memory is accepted lazily to
5+
avoid prolonged boot times. The lazy option will add
6+
some runtime overhead until all memory is eventually
7+
accepted. In most cases the overhead is negligible.
8+
For some workloads or for debugging purposes
9+
accept_memory=eager can be used to accept all memory
10+
at once during boot.
11+
112
acpi= [HW,ACPI,X86,ARM64,RISCV64]
213
Advanced Configuration and Power Interface
314
Format: { force | on | off | strict | noirq | rsdt |

‎Documentation/admin-guide/media/index.rst‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,8 @@ Documentation/driver-api/media/index.rst
2020
- for driver development information and Kernel APIs used by
2121
media devices;
2222

23-
The media subsystem
24-
===================
25-
26-
.. only:: html
27-
28-
.. class:: toc-title
29-
30-
Table of Contents
31-
3223
.. toctree::
24+
:caption: Table of Contents
3325
:maxdepth: 2
3426
:numbered:
3527

‎Documentation/arch/x86/boot.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Protocol 2.13 (Kernel 3.14) Support 32- and 64-bit flags being set in
7171

7272
Protocol 2.14 BURNT BY INCORRECT COMMIT
7373
ae7e1238e68f2a472a125673ab506d49158c1889
74-
(x86/boot: Add ACPI RSDP address to setup_header)
74+
("x86/boot: Add ACPI RSDP address to setup_header")
7575
DO NOT USE!!! ASSUME SAME AS 2.13.
7676

7777
Protocol 2.15 (Kernel 5.5) Added the kernel_info and kernel_info.setup_type_max.

‎Documentation/bpf/btf.rst‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -272,10 +272,8 @@ In this case, if the base type is an int type, it must be a regular int type:
272272
* ``BTF_INT_OFFSET()`` must be 0.
273273
* ``BTF_INT_BITS()`` must be equal to ``{1,2,4,8,16} * 8``.
274274

275-
The following kernel patch introduced ``kind_flag`` and explained why both
276-
modes exist:
277-
278-
https://github.com/torvalds/linux/commit/9d5f9f701b1891466fb3dbb1806ad97716f95cc3#diff-fa650a64fdd3968396883d2fe8215ff3
275+
Commit 9d5f9f701b18 introduced ``kind_flag`` and explains why both modes
276+
exist.
279277

280278
2.2.6 BTF_KIND_ENUM
281279
~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)