linux.git/tools/lib/python/kdoc, branch master

Merge tag 'docs-7.4-2' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux

2026-10-29T17:46:22+00:00

Pull more documentation updates from Jonathan Corbet: "A handful of late-arriving changes, most of which were ready ahead of the merge window: - More Portuguese translation updates - Some docs-build and self-test fixes - Bring documentation for the user-space access primitives in include/linux/uaccess.h into the docs build. This revealed a number of malformed kerneldoc comments, which are fixed in a subsequent tweak to uaccess.h" * tag 'docs-7.4-2' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux: uaccess: fix some erroneous kerneldoc comments docs/translations/pt_BR: admin-guide: add efi-stub.rst docs/translations/pt_BR: admin-guide: add kernel-parameters.rst docs/translations/pt_BR: admin-guide: add bootconfig.rst docs/translations/pt_BR: admin-guide: add perf-security.rst docs/translations/pt_BR: admin-guide: add LSM/index.rst docs/translations/pt_BR: admin-guide: add hw-vuln/index.rst docs/translations/pt_BR: admin-guide: add cputopology.rst docs/translations/pt_BR: admin-guide: add sysctl/index.rst docs/translations/pt_BR: admin-guide: add sysfs-rules.rst docs/translations/pt_BR: admin-guide: add features.rst docs: pt_BR: process: translate userspace debugging guide docs: kerneldoc.py: preserve headings in kernel-doc output docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members docs: test_doc_build: don't select urllib3 yanked version docs: test_doc_build: address pylint warnings docs: test_doc_build: update it to support newer Sphinx versions docs: test_doc_build: better handle python version docs: admin-guide: Fix typo in kernel-parameters.txt docs: core-api: include documentation from linux/uaccess.h

docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members

2026-10-22T15:45:11+00:00

KHO ABI structures declare their preservation pointers with DECLARE_KHOSER_PTR(name, type), which expands to a union of the pointer and its physical address. kernel-doc does not know the macro and does not see the member: it warns that an unnamed member is not described and that the description of the member is excess. Translate DECLARE_KHOSER_PTR(name, type) into "type name", as is done for DECLARE_KFIFO_PTR(). Signed-off-by: Pasha Tatashin Message-ID: <20261015020313.946940-1-pasha.tatashin@soleen.com> Signed-off-by: Jonathan Corbet

Merge tag 'docs-7.4' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux

2026-10-21T00:38:38+00:00

Pull documentation updates from Jonathan Corbet: "It was a reasonably busy cycle for docs; changes include: - Add the AGENTS.md symbolic link into the top-level directory in the hopes that LLMs will read it and produce better work - The removal of the Assisted-by requirement, as concluded at the Maintainer Summit - A new "testdocs" make target to run the documentation unit tests - Lots of work on the Portuguese, and Chinese translations; there is now maintenance for the traditional Chinese translations as well ...and the usual pile of minor fixes, documentation updates, etc" * tag 'docs-7.4' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux: (125 commits) docs: add AGENTS.md as a symlink to README docs: kernel-parameters: adjust reserve_mem build option docs: kernel-parameters: don't mix cmdline options & build options docs/ja_JP: translate submitting-patches.rst (review and report tags) docs: remove Assisted-by references Revert "docs: landlock: fix ENOMSG condition in create_ruleset kernel-doc" docs: kdoc: parse context_lock_struct() as struct declaration docs: timers: hpet: Document userspace API and ioctl commands docs: timers: hpet: Modernize file references Documentation: sched-preemption: Add a SPDX license identifier docs: ABI: sysfs-driver-xdata: use literal blocks for console commands docs: ABI: sysfs-class-firmware-attributes: use literal blocks for console commands ABI: sysfs-bus-usb: use literal block for console commands docs/ABI: testing: aspeed-uart-routing: use literal block for console commands docs: kernel-parameters: fix a truncated sentence for preempt=lazy sched/doc: add a preemption model overview docs: ABI: TMR manager: use literal blocks for console I/O Documentation/ABI: IFS: use literal blocks for commands ABI: sysfs-bus-pci: use literal blocks for commands docs: translations: pt_BR: add debugging index ...

pid: add helpers to operate on a struct pid array

2026-10-12T08:58:20+00:00

We're about to extend af_unix sockets and coredump code with the ability to hand out thread-specific pidfds. Add a few simple helpers that allow to operate on multiple struct pids up to PIDTYPE_MAX with automatic bounds checking. Reviewed-by: Alexander Mikhalitsyn Reviewed-by: Kuniyuki Iwashima Signed-off-by: Andrew Halaney Link: https://patch.msgid.link/20261005-work-unix-passpidfd-v4-1-350183b6e02a@amutable.com Signed-off-by: Christian Brauner (Amutable)

docs: kdoc: parse context_lock_struct() as struct declaration

2026-09-29T22:59:29+00:00

kernel-doc fails to parse struct declarations wrapped in context_lock_struct(), e.g. struct debugfs_cancellation: include/linux/debugfs.h:245 ... error: Cannot parse struct or union! Add a struct transform that expands context_lock_struct() to a plain struct declaration, and apply the struct transforms to the whole declaration before split_struct_proto(), matching what dump_var() and dump_function() already do for their prototypes. The member-only transform in dump_struct() is then redundant. Add a regression test for the debugfs_cancellation declaration. Fixes: 6e530e2e3119 ("debugfs: Make debugfs_cancellation a context lock struct") Signed-off-by: Omokefe Emmanuel Onanaroghene Tested-by: Randy Dunlap Reviewed-by: Aleksandr Loktionov Signed-off-by: Jonathan Corbet Message-ID: <20260925234054.128477-1-emmaonana18@gmail.com>

tools/lib: fix typos in comments

2026-09-07T16:37:58+00:00

Fix typos in comments, reported by scripts/checkpatch.pl using the misspelling list in scripts/spelling.txt. Only touches comments, no code changes. Assisted-by: Cursor:claude-opus-5 Signed-off-by: Hemanth Selam Reviewed-by: Randy Dunlap Signed-off-by: Jonathan Corbet Message-ID: <20260904113257.13594-3-hemanth.selam@gmail.com>

docs: xforms_lists: support DEFINE_IDTENTRY_IRQ()

2026-08-03T18:57:56+00:00

Avoid kernel-doc warnings by supported DEFINE_IDTENTRY_IRQ() as a function transform. Warning: arch/x86/kernel/apic/apic.c:2157 function parameter 'spurious_interrupt' not described in 'DEFINE_IDTENTRY_IRQ' Warning: arch/x86/kernel/apic/apic.c:2157 expecting prototype for spurious_interrupt(). Prototype was for DEFINE_IDTENTRY_IRQ() instead Signed-off-by: Randy Dunlap Signed-off-by: Jonathan Corbet Message-ID: <20260723190151.507295-1-rdunlap@infradead.org>

docs: kdoc_parser: drop extraneous blank line in warning message

2026-08-03T18:07:17+00:00

Drop an extra newline (blank line) on warning messages for (2 places): expecting prototype for typedef. Prototype was for typedef {symbol} instead and expecting prototype for {struct|union}. Prototype was for struct|union {symbol} instead This makes these messages consistent with the similar enum warning, which has no extra blank line. Signed-off-by: Randy Dunlap Signed-off-by: Jonathan Corbet Message-ID: <20260729052736.1423688-1-rdunlap@infradead.org>

scripts/kernel-doc: Fix kdoc for Python 3.9-3.11

2026-08-03T17:12:49+00:00

The syntax used by the excess description suggestion change works on Python 3.12+, while we need to support 3.9+. Signed-off-by: Ryszard Knop Tested-by: Akira Yokosawa Fixes: d7758384ccb4 ("scripts/kernel-doc: Suggest possible names for excess descriptions") Reported-by: Akira Yokosawa Closes: https://lore.kernel.org/22a9276d-c103-4306-a617-7f34abcd5c29@gmail.com/ Signed-off-by: Jonathan Corbet Message-ID: <20260731144508.912049-1-ryszard.knop@intel.com>

scripts/kernel-doc: Suggest possible names for excess descriptions

2026-07-22T16:10:44+00:00

Recent check_sections() change added a warning if a documentation tag member name does not match the detected struct/union member names. Since the checker knows all possible names, we can suggest known names, so that it's more obvious how to deal with the warning. Signed-off-by: Ryszard Knop Tested-by: Randy Dunlap Acked-by: Randy Dunlap Signed-off-by: Jonathan Corbet Message-ID: <20260717125753.634550-1-ryszard.knop@intel.com>