Skip to content

Commit b1cce98

Browse files
committed
Merge tag 'docs-6.17' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "It has been a relatively busy cycle for docs, especially the build system: - The Perl kernel-doc script was added to 2.3.52pre1 just after the turn of the millennium. Over the following 25 years, it accumulated a vast amount of cruft, all in a language few people want to deal with anymore. Mauro's Python replacement in 6.16 faithfully reproduced all of the cruft in the hope of avoiding regressions. Now that we have a more reasonable code base, though, we can work on cleaning it up; many of the changes this time around are toward that end. - A reorganization of the ext4 docs into the usual TOC format. - Various Chinese translations and updates. - A new script from Mauro to help with docs-build testing. - A new document for linked lists - A sweep through MAINTAINERS fixing broken GitHub git:// repository links. ...and lots of fixes and updates" * tag 'docs-6.17' of git://git.lwn.net/linux: (147 commits) scripts: add origin commit identification based on specific patterns sphinx: kernel_abi: fix performance regression with O=<dir> Documentation: core-api: entry: Replace deprecated KVM entry/exit functions docs: fault-injection: drop reference to md-faulty docs: document linked lists scripts: kdoc: make it backward-compatible with Python 3.7 docs: kernel-doc: emit warnings for ancient versions of Python Documentation/rtla: Describe exit status Documentation/rtla: Add include common_appendix.rst docs: kernel: Clarify printk_ratelimit_burst reset behavior Documentation: ioctl-number: Don't repeat macro names Documentation: ioctl-number: Shorten macros table Documentation: ioctl-number: Correct full path to papr-physical-attestation.h Documentation: ioctl-number: Extend "Include File" column width Documentation: ioctl-number: Fix linuxppc-dev mailto link overlayfs.rst: fix typos docs: kdoc: emit a warning for ancient versions of Python docs: kdoc: clean up check_sections() docs: kdoc: directly access the always-there KdocItem fields docs: kdoc: straighten up dump_declaration() ...
2 parents 260f6f4 + 35293eb commit b1cce98

Some content is hidden

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

83 files changed

+3748
-1439
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ modules.order
114114
!.gitignore
115115
!.kunitconfig
116116
!.mailmap
117+
!.pylintrc
117118
!.rustfmt.toml
118119

119120
#

Documentation/ABI/README

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ Every file in these directories will contain the following information:
4646

4747
What: Short description of the interface
4848
Date: Date created
49-
KernelVersion: Kernel version this feature first showed up in.
49+
KernelVersion: (Optional) Kernel version this feature first showed up in.
50+
Note: git history often provides more accurate version
51+
info, so this field may be omitted.
5052
Contact: Primary contact for this interface (may be a mailing list)
5153
Description: Long description of the interface and how to use it.
5254
Users: All users of this interface who wish to be notified when

Documentation/Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# for cleaning
66
subdir- := devicetree/bindings
77

8+
ifneq ($(MAKECMDGOALS),cleandocs)
89
# Check for broken documentation file references
910
ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)
1011
$(shell $(srctree)/scripts/documentation-file-ref-check --warn)
@@ -14,6 +15,7 @@ endif
1415
ifeq ($(CONFIG_WARN_ABI_ERRORS),y)
1516
$(shell $(srctree)/scripts/get_abi.py --dir $(srctree)/Documentation/ABI validate)
1617
endif
18+
endif
1719

1820
# You can set these variables from the command line.
1921
SPHINXBUILD = sphinx-build

Documentation/admin-guide/bootconfig.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ The final kernel cmdline will be the following::
265265
Config File Limitation
266266
======================
267267

268-
Currently the maximum config size size is 32KB and the total key-words (not
268+
Currently the maximum config size is 32KB and the total key-words (not
269269
key-value entries) must be under 1024 nodes.
270270
Note: this is not the number of entries but nodes, an entry must consume
271271
more than 2 nodes (a key-word and a value). So theoretically, it will be

Documentation/admin-guide/sysctl/kernel.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@ core_pattern
177177
%E executable path
178178
%c maximum size of core file by resource limit RLIMIT_CORE
179179
%C CPU the task ran on
180+
%F pidfd number
180181
%<OTHER> both are dropped
181182
======== ==========================================
182183

@@ -1106,7 +1107,8 @@ printk_ratelimit_burst
11061107
While long term we enforce one message per `printk_ratelimit`_
11071108
seconds, we do allow a burst of messages to pass through.
11081109
``printk_ratelimit_burst`` specifies the number of messages we can
1109-
send before ratelimiting kicks in.
1110+
send before ratelimiting kicks in. After `printk_ratelimit`_ seconds
1111+
have elapsed, another burst of messages may be sent.
11101112

11111113
The default value is 10 messages.
11121114

Documentation/arch/powerpc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ powerpc
1919
elf_hwcaps
2020
elfnote
2121
firmware-assisted-dump
22+
htm
2223
hvcs
2324
imc
2425
isa-versions

0 commit comments

Comments
 (0)