summaryrefslogtreecommitdiff
AgeCommit message (Collapse)AuthorFilesLines
2026-01-23docs: add kernel-doc modules documentationMauro Carvalho Chehab6-0/+112
Place kernel-doc modules documentation at Linux Kernel docs. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <88ac2d82a45718c4e27aefac831586a71204ebf2.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: kdoc: python_version: Improve docstrings and commentsMauro Carvalho Chehab1-4/+16
In preparation to document kernel-doc module, improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <2153afaeb496e1bb8d3cc318fff26c3f99d99486.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: kdoc: enrich_formatter: Improve docstrings and commentsMauro Carvalho Chehab1-5/+15
In preparation to document kernel-doc module, improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <55ec8b896fe00529d326859cd094230fb5a2cd30.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: kdoc: parse_data_structs: Improve docstrings and commentsMauro Carvalho Chehab1-23/+39
In preparation to document kernel-doc module, improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <76ead85b4c13a8038180a792e270c3691d26cd25.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: kdoc_re: Improve docstrings and commentsMauro Carvalho Chehab1-7/+11
In preparation to document kernel-doc module, improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <14a12a43144d52345bfd405d0401d246f0885acf.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: kdoc_output: Improve docstrings and commentsMauro Carvalho Chehab1-25/+35
In preparation to document kernel-doc module, improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <ac03bf776f0929bbe822cd8269f2a31e275b8d6b.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: kdoc_parser: Improve docstrings and commentsMauro Carvalho Chehab1-78/+93
In preparation to document kernel-doc module, improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <b6aabe25b45e9751885becd544a4db82dbe11ff2.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: kdoc_item: Improve docstrings and commentsMauro Carvalho Chehab1-0/+18
In preparation to document kernel-doc module, improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <65a7c6bb318e7a8cbf5c115903d507568099151a.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: kdoc_files: Improve docstrings and commentsMauro Carvalho Chehab1-11/+12
In preparation to document kernel-doc module, improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <75d58878ad6f83f24f1c0ce9e04301a000ecbaa3.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: kdoc: latex_fonts: Improve docstrings and commentsMauro Carvalho Chehab1-39/+56
In preparation to document kernel-doc module, improve its documentation. Among the changes, it had to place the xml template inside a code block, as otherwise doc build would break. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <6e0eb2e245eae9b4f39cf231dee32df00b9e8b7b.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: custom.css: add CSS for pythonMauro Carvalho Chehab1-0/+9
As we'll start adding python to documentation, add some CSS templates to better display python code. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <b5a3dfd551b887a2885b85b4c9433e757c77628a.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: enable Sphinx autodoc extension to allow documenting pythonMauro Carvalho Chehab1-0/+5
Adding python documentation is simple with Sphinx: all we need is to include the ext.autodoc extension and add the directories where the Python code sits at the sys.path. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <29cbe375dc418d6fa5793f55199799b5b52dcd38.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: conf: don't rely on cwd to get documentation locationMauro Carvalho Chehab1-7/+5
Instead of relying that Sphinx will be called from Documentation/ dir, pick the location based on __file__. Suggested-by: Jani Nikula <jani.nikula@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <34c38718dfade91ff6f7afca5e9c1705ba253c97.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: conf.py: don't use doctree with a different meaningMauro Carvalho Chehab1-4/+4
At Sphinx, doctree is a directory where doc build cache is stored. Use a better name. No functional changes. Suggested-by: Jani Nikula <jani.nikula@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <bab090bb4b95c735bd570c9c23c6e97851b2bf7b.1768838938.git.mchehab+huawei@kernel.org>
2026-01-23docs: custom.css: prevent li marker to override textMauro Carvalho Chehab1-0/+3
There's currently an issue with li marker: it is set to use -1em, which actually makes it override the text. This is visible on indexes that are deep enough. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <4f28c485b72ea27c0981cd950a1819597d6736b1.1768838938.git.mchehab+huawei@kernel.org>
2026-01-21Documentation: Provide guidelines for tool-generated contentDave Hansen2-0/+110
In the last few years, the capabilities of coding tools have exploded. As those capabilities have expanded, contributors and maintainers have more and more questions about how and when to apply those capabilities. Add new Documentation to guide contributors on how to best use kernel development tools, new and old. Note, though, there are fundamentally no new or unique rules in this new document. It clarifies expectations that the kernel community has had for many years. For example, researchers are already asked to disclose the tools they use to find issues by Documentation/process/researcher-guidelines.rst. This new document just reiterates existing best practices for development tooling. In short: Please show your work and make sure your contribution is easy to review. Signed-off-by: Dave Hansen <dave.hansen@linux.intel.com> Reviewed-by: Shuah Khan <shuah@kernel.org> Reviewed-by: Kees Cook <kees@kernel.org> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Reviewed-by: Miguel Ojeda <ojeda@kernel.org> Reviewed-by: Luis Chamberlain <mcgrof@kernel.org> Reviewed-by: SeongJae Park <sj@kernel.org> Reviewed-by: Dan Williams <dan.j.williams@intel.com> Reviewed-by: Steven Rostedt <rostedt@goodmis.org> Reviewed-by: Paul E. McKenney <paulmck@kernel.org> Reviewed-by: Simon Glass <simon.glass@canonical.com> Reviewed-by: Lee Jones <lee@kernel.org> Reviewed-by: Lorenzo Stoakes <lorenzo.stoakes@oracle.com> Cc: NeilBrown <neilb@ownmail.net> Cc: Lorenzo Stoakes <lorenzo.stoakes@oracle.com> Cc: Dan Williams <dan.j.williams@intel.com> Cc: Theodore Ts'o <tytso@mit.edu> Cc: Sasha Levin <sashal@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Vlastimil Babka <vbabka@suse.cz> Cc: workflows@vger.kernel.org Cc: ksummit@lists.linux.dev Link: https://lore.kernel.org/all/cfb8bb96-e798-474d-bc6f-9cf610fe720f@lucifer.local/ -- Changes from v5: * Add more review tags * Add a blurb to the "special" asks bullet to mention that extra testing may be requested. * Reword the closing paragraph of "Out of Scope" section for clarity * Remove an "AI" and make small wording tweak (Jon) Changes from v4: * Modest tweaking and rewording to strengthen language * Add a section to help alleviate concerns that the document would not enable maintainers to act forcefully enough in the face of high-volume low-quality contributions (aka. AI slop). This is very close to some text that Lorenzo posted. I just made some very minor wording tweaks and spelling fixes. * Note: v4 mistakenly had "v3" in the subject Changes from v3: * Wording/formatting tweaks (Randy) Changes from v2: * Mention testing (Shuah) * Remove "very", rename LLM => coding assistant (Dan) * More formatting sprucing up and minor typos (Miguel) * Make changelog and text less flashy (Christian) * Tone down critical=>helpful (Neil) Changes from v1: * Rename to generated-content.rst and add to documentation index. (Jon) * Rework subject to align with the new filename * Replace commercial names with generic ones. (Jon) * Be consistent about punctuation at the end of bullets for whole sentences. (Miguel) * Formatting sprucing up and minor typos (Miguel) This document was a collaborative effort from all the members of the TAB. I just reformatted it into .rst and wrote the changelog. Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260119200418.89541-1-dave.hansen@linux.intel.com>
2026-01-16docs: filesystems: add fs/open.c to api-summaryRandy Dunlap1-0/+3
Include fs/open.c in filesystems/api-summary.rst to provide its exported APIs. Suggested-by: Matthew Wilcox <willy@infradead.org> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Christian Brauner <brauner@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260104204530.518206-1-rdunlap@infradead.org>
2026-01-16docs: make kptr_restrict and hash_pointers reference each otherMarc Herbert2-0/+6
vsprintf.c uses a mix of the `kernel.kptr_restrict` sysctl and the `hash_pointers` boot param to control pointer hashing. But that wasn't possible to tell without looking at the source code. They have a different focus and purpose. To avoid wasting the time of users trying to use one instead of the other, simply have them reference each other in the Documentation. Signed-off-by: Marc Herbert <marc.herbert@linux.intel.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260107-doc-hash-ptr-v2-1-cb4c161218d7@linux.intel.com>
2026-01-16Documentation: CSS: Improve man page fontPetr Vorel1-1/+7
Define man page font as monospace and bold, i.e. the same as what is used for .code and <pre>. Signed-off-by: Petr Vorel <pvorel@suse.cz> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260113113612.315748-4-pvorel@suse.cz>
2026-01-16Documentation: Link man pages to https://man7.org/Petr Vorel1-0/+3
Configure manpages_url to link man pages to https://man7.org/. https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url Acked-by: Alejandro Colomar <alx@kernel.org> Signed-off-by: Petr Vorel <pvorel@suse.cz> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260113113612.315748-3-pvorel@suse.cz>
2026-01-16Documentation: Remove :manpage: from non-existing man pagesPetr Vorel3-24/+24
Removing :manpage: from non-existing man pages (xyzzy(2), xyzzyat(2), fxyzzy(3) in adding-syscalls.rst, including translations) prevent adding link to nonexisting man pages when using manpages_url in next commit. While at it, add also missing '(2)' in sp_SP translation. Reviewed-by: Alejandro Colomar <alx@kernel.org> Signed-off-by: Petr Vorel <pvorel@suse.cz> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260113113612.315748-2-pvorel@suse.cz>
2026-01-16driver-core: improve driver binding documentationDanilo Krummrich1-3/+6
The driver binding documentation (still) mentions that "When a driver is attached to a device, the device is inserted into the driver's list of devices.". While it is true that the driver-core keeps track of all the devices that are attached to a driver, this is purely for internal purposes (i.e. it is an implementation detail) and has no relevance for user facing documentation. In fact, it is even misleading, since it could be read as if it were valid for driver implementations to keep track of all the devices bound to it. Instead, drivers operate on a per-device basis, with a separate per-device instance created when the driver is bound to a device. Hence, remove the mention of a driver's list of devices and instead add some documentation of the relationship between drivers and devices. Signed-off-by: Danilo Krummrich <dakr@kernel.org> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260115215718.6405-1-dakr@kernel.org>
2026-01-16Documentation: Fix typos and grammatical errorsNauman Sabir7-17/+17
Fix various typos and grammatical errors across documentation files: - Fix missing preposition 'in' in process/changes.rst - Correct 'result by' to 'result from' in admin-guide/README.rst - Fix 'before hand' to 'beforehand' in cgroup-v1/hugetlb.rst - Correct 'allows to limit' to 'allows limiting' in hugetlb.rst, cgroup-v2.rst, and kconfig-language.rst - Fix 'needs precisely know' to 'needs to precisely know' - Correct 'overcommited' to 'overcommitted' in hugetlb.rst - Fix subject-verb agreement: 'never causes' to 'never cause' - Fix 'there is enough' to 'there are enough' in hugetlb.rst - Fix 'metadatas' to 'metadata' in filesystems/erofs.rst - Fix 'hardwares' to 'hardware' in scsi/ChangeLog.sym53c8xx Signed-off-by: Nauman Sabir <officialnaumansabir@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Message-ID: <20260115230110.7734-1-officialnaumansabir@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2026-01-12Documentation/trace: Fix links to other documentsPetr Vorel2-2/+2
Link to another document does not require 'file:'. Removing it fixes links in generated html docs. Signed-off-by: Petr Vorel <pvorel@suse.cz> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260111223643.174812-2-pvorel@suse.cz>
2026-01-12Documentation: bug-hunting.rst: Remove wrong 'file:' syntaxPetr Vorel1-3/+3
Link to another document does not require 'file:', therefore it was shown in generated html. Preformatted text requires just ``...``. Signed-off-by: Petr Vorel <pvorel@suse.cz> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260111223643.174812-1-pvorel@suse.cz>
2026-01-12MAINTAINERS: Update for the doc subsystemShuah Khan1-0/+2
Adding myself as a reviewer for doc subsystem. Signed-off-by: Shuah Khan <skhan@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260106231316.24474-1-skhan@linuxfoundation.org>
2026-01-12CREDITS: add whitespace before opening parenthesesDiego Viola1-4/+4
in order to maintain consistent formatting across the file. Signed-off-by: Diego Viola <diego.viola@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260107080411.59483-1-diego.viola@gmail.com>
2026-01-12tools: jobserver: Prevent deadlock caused by incorrect jobserver ↵Changbin Du1-1/+6
configuration and enhance error reporting When using GNU Make's jobserver feature in kernel builds, a bug in MAKEFLAGS propagation caused "--jobserver-auth=r,w" to reference an unintended file descriptor. This led to infinite loops in jobserver-exec's os.read() calls due to empty token. My shell opened /etc/passwd for some reason without closing it, and as a result, all child processes inherited this fd 3. $ ls -l /proc/self/fd total 0 lrwx------ 1 changbin changbin 64 Dec 25 13:03 0 -> /dev/pts/1 lrwx------ 1 changbin changbin 64 Dec 25 13:03 1 -> /dev/pts/1 lrwx------ 1 changbin changbin 64 Dec 25 13:03 2 -> /dev/pts/1 lr-x------ 1 changbin changbin 64 Dec 25 13:03 3 -> /etc/passwd lr-x------ 1 changbin changbin 64 Dec 25 13:03 4 -> /proc/1421383/fd In this case, the `make` should open a new file descriptor for jobserver control, but clearly, it did not do so and instead still passed fd 3 as "--jobserver-auth=3,4" in MAKEFLAGS. (The version of my gnu make is 4.3) This update ensures robustness against invalid jobserver configurations, even when `make` incorrectly pass non-pipe file descriptors. * Rejecting empty reads to prevent infinite loops on EOF. * Clearing `self.jobs` to avoid writing to incorrect files if invalid tokens are detected. * Printing detailed error messages to stderr to inform the user. Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Changbin Du <changbin.du@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260108113836.2976527-1-changbin.du@huawei.com>
2026-01-07Documentation/kernel-parameters: Add tsa under mitigations=offYu Liao1-0/+1
On X86 AMD systems, mitigations=off also disables the Transient Scheduler Attacks (TSA) mitigation. Add it to the list. Signed-off-by: Yu Liao <liaoyu.ly@bytedance.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251225121438.38427-1-liaoyu.ly@bytedance.com>
2026-01-07docs: spufs: fix ppc64 architecture line breakAkiyoshi Kurita2-4/+4
Fix a broken line break in the word "architecture" in the spufs documentation. Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251225161615.3107808-1-weibu@redadmin.org>
2026-01-07doc: input: fix typos in input.rstWu Canhong1-1/+1
'even codes' should be 'event codes' at the end of input.rst Signed-off-by: Wu Canhong <canhong12@163.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251226160219.64818-1-canhong12@163.com>
2026-01-07Documentation: kernel-hacking: Remove :c:func: annotationsThorsten Blum1-85/+84
Remove the useless :c:func: annotations. Suggested-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251222232506.2615-2-thorsten.blum@linux.dev>
2026-01-07Documentation: kernel-hacking: Convert internal linksBagas Sanjaya1-3/+3
Convert internal cross-references in "Putting Your Stuff in the kernel" section from inline code to internal links. Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251223035254.22894-4-bagasdotme@gmail.com>
2026-01-07Documentation: kernel-hacking: Do not italicize EXPORT_SYMBOL{,_GPL}() ↵Bagas Sanjaya1-2/+2
references Do not italicize EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL() references in EXPORT_SYMBOL_NS() and EXPORT_SYMBOL_NS_GPL() subsections. Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251223035254.22894-3-bagasdotme@gmail.com>
2026-01-07Documentation: kernel-hacking: Remove current macro annotationBagas Sanjaya1-2/+2
Remove unneeded :c:macro: annotation of current macro. Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251223035254.22894-2-bagasdotme@gmail.com>
2026-01-07docs: admin: devices: remove /dev/cdwriterMax Nikulin1-3/+2
Remove /dev/cdwriter from the local symlinks table and from the related note. Creation of the symlink was removed from udev in commit [1] that became a part of release 115 in 2007 [2]. The altered text was added in 1995 [3]. [1] https://git.kernel.org/pub/scm/linux/hotplug/udev.git/commit/?id=b1a2b83f2d 2007-08-11 14:06:03 +0200 Kay Sievers. rules: update Fedora rules [2] https://git.kernel.org/pub/scm/linux/hotplug/udev.git/commit/?h=7e599863919 2007-08-24 01:29:54 +0200 Kay Sievers. release 115 [3] https://git.kernel.org/pub/scm/linux/kernel/git/history/history.git/diff/Documentation/devices.txt?h=v2.5.45&id=6e995ea941a 1995-11-21 Linus Torvalds. Import 1.3.43 Signed-off-by: Max Nikulin <manikulin@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <f5c3f6e9-cd92-47e3-89c3-06dbcfc98c17@gmail.com>
2026-01-07docs: keystone: fix typo in knav-qmss documentationAkiyoshi Kurita1-1/+1
Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251223112946.2580519-1-weibu@redadmin.org>
2026-01-07docs: add AI Coding Assistants documentationSasha Levin3-0/+72
Add guidance for AI assistants and developers using AI tools for kernel contributions, per the consensus reached at the 2025 Maintainers Summit. Create Documentation/process/coding-assistants.rst with detailed guidance on licensing, Signed-off-by requirements, and attribution format. The README points AI tools to this documentation. This will allow coding assistants to easily parse these instructions and comply with guidelines set by the community. Link: https://lwn.net/Articles/1049830/ Signed-off-by: Sasha Levin <sashal@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251223122110.2496946-1-sashal@kernel.org>
2026-01-07Docs/translations/ko_KR: remove memory-barriersSeongJae Park3-2971/+0
The memory-barriers.txt Korean translation is quite outdated. The last update on the translation was made on 2022-10-10, by commit ee5a86f451f7 ("docs/memory-barriers.txt/kokr: Fix confusing name of 'data dependency barrier'"). After the date, the original memory-barriers.txt got seven more changes so far. The most recent one was made on 2025-11-05. But none of those are applied to the translation. Maybe I can work again on keeping it updated. But, given the advancement of translation tools, I think it might not be worth keeping it at all. Remove the outdated translation. If it turns out to be worthy to keep the translation and someone willing to keep it updated steps up, this could be reverted. This change was inspired from the last kernel summit discussion [1]. [1] https://lpc.events/event/19/contributions/2259/ Cc: Paul E. McKenney <paulmck@kernel.org> Signed-off-by: SeongJae Park <sj@kernel.org> Acked-by: Paul E. McKenney <paulmck@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251225014027.15948-1-sj@kernel.org>
2026-01-07docs: submitting-patches: suggest adding previous version linksSeongJae Park1-1/+5
For review of patches that revisioned multiple times, patch changelogs are very useful. Adding actual links to the previous versions can further help the review. Using such links, reviewers can double check the changelog by themselves, and find previous discussions. Nowadays having such links (e.g., lore.kernel.org archive links) is easy and reliable. Suggest adding such links if available. Signed-off-by: SeongJae Park <sj@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251225015447.16387-1-sj@kernel.org>
2026-01-07doc-guide: kernel-doc: specify that W=n does not check header filesVincent Mailhol1-2/+5
The documentation states that: make W=n can be used to verify the documentation format. This is true for .c files but not for headers [1]. Modify the documentation to specify that headers files are not covered by make W=n and that these need to be checked separately with scripts/kernel-doc. [1] commit 3a025e1d1c2e ("Add optional check for bad kernel-doc comments") Link: https://git.kernel.org/torvalds/c/3a025e1d1c2e Signed-off-by: Vincent Mailhol <mailhol@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251225-doc-format-check-v1-1-dff637a4d275@kernel.org>
2026-01-07Doc: correct spelling and wording mistakesVolodymyr Kot4-6/+6
Fixed capitalization and punctuation in process documentation. Signed-off-by: Volodymyr Kot <volodymyr.kot.ua@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251225133911.87512-1-volodymyr.kot.ua@gmail.com>
2026-01-07docs: process: email-client: add Thunderbird "Toggle Line Wrap" extensionVincent Mailhol1-1/+8
While reading the git-format-patch manpages [1], I discovered the existence of the "Toggle Line Wrap" extension for Thunderbird which I found rather convenient. Looking at the history, the ancestor of this extension was added to the documentation in commit e0e34e977a7c ("Documentation/email-clients.txt: update Thunderbird docs with wordwrap plugin") but then removed in commit f9a0974d3f70 ("Documentation: update thunderbird email client settings"). Extend the paragraph on Thunderbird's mailnews.wraplength register to mention the existence of the "Toggle Line Wrap" extension. The goal is not to create a war on what is the best option so make it clear that this is just an alternative. [1] man git-format-patch -- §Thunderbird Link: https://git-scm.com/docs/git-format-patch#_thunderbird Signed-off-by: Vincent Mailhol <mailhol@kernel.org> Reviewed-by: Gal Pressman <gal@nvidia.com> Acked-by: Sotir Danailov <sndanailov@gmail.com> # As past commit author Acked-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251226-docs_thunderbird-toggle-line-wrap-v2-1-aebb8c60025d@kernel.org>
2026-01-07docs: Makefile: wrap SPHINXDIRS help textMustafa Elrasheid1-1/+2
When using `make help`, SPHINXDIR doesn't wrap around 80 characters, causing text to overflow or wrap in incorrect ways, which then makes the text difficult to read Signed-off-by: Mustafa Elrasheid <mustafaelrasheid@gmail.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251227125244.6407-1-mustafaelrasheid@gmail.com>
2026-01-07docs: find-unused-docs.sh: fixup directory usageRandy Dunlap1-1/+1
The recent move of this script from scripts/ to tools/docs/ did not account for the 'cd' directory usage. Update "cd .." to "cd ../.." to make the script self-correcting. This also eliminates a shell warning: ./tools/docs/find-unused-docs.sh: line 33: cd: Documentation/: No such file or directory Fixes: 184414c6a6ca ("docs: move find-unused-docs.sh to tools/docs") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Fixes: 184414c6a6ca (docs: move find-unused-docs.sh to tools/docs) Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260102200657.1040234-1-rdunlap@infradead.org>
2026-01-07docs/ja_JP: fix typos in submit-checklist.rstMasaharu Noguchi1-2/+2
Fix spelling errors in the Japanese translation: - "Menu attibutes: default value" -> "Menu attributes: default value" - "Documentaion/ABI/" -> "Documentation/ABI/" No change in meaning intended. Signed-off-by: Masaharu Noguchi <nogunix@gmail.com> Acked-by: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260103-b4-practice-docs-typo-v1-1-d68ad6a22ab5@gmail.com>
2026-01-07docs/ja_JP: fix translation of freestanding C environmentMasaharu Noguchi1-1/+1
The current Japanese translation incorrectly implies that the kernel is independent of the C language. Translate "freestanding C environment" accurately. Signed-off-by: Masaharu Noguchi <nogunix@gmail.com> Reviewed-by: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260104-ja-howto-v2-2-8cac525b3dfe@gmail.com>
2026-01-07docs/ja_JP: fix typos and duplicated phrases in kernel development guideMasaharu Noguchi1-2/+2
Fix obvious typos and duplicated phrases in the Japanese translation. No change in meaning intended. Acked-by: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Masaharu Noguchi <nogunix@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260104-ja-howto-v2-1-8cac525b3dfe@gmail.com>
2025-12-23MAINTAINERS: Add doc files on real-time support to Real-time LinuxLukas Bulwahn1-0/+1
Commit f51fe3b7e48c ("Documentation: Add real-time to core-api") adds new documentation on real-time support, i.e., PREEMPT_RT. So, add a file entry for that directory to the corresponding section in MAINTAINERS. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@redhat.com> Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251127154343.292156-4-bigeasy@linutronix.de>
2025-12-23Documentation: update config name in real-time architecture supportLukas Bulwahn1-1/+2
Commit 4843a45ef9fe8 ("entry: Rename "kvm" entry code assets to "virt" to genericize APIs") renames the config KVM_XFER_TO_GUEST_WORK to VIRT_XFER_TO_GUEST_WORK. Adjust the documentation to the current situation, and specifically refer to the new name of the config. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@redhat.com> Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251127154343.292156-3-bigeasy@linutronix.de>
generated by cgit v1.2.3 (git 2.39.0) at 2026-05-04 02:49:24 +0300