Commit Graph
1412382 Commits
Author SHA1 Message Date
Thorsten Blum 736ea81026 Documentation: kernel-hacking: Remove :c:func: annotations
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-06 15:15:15 -07:00
Bagas Sanjaya bb51cf4f61 Documentation: kernel-hacking: Convert internal links
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-06 15:08:43 -07:00
Bagas Sanjaya 2b79aafb17 Documentation: kernel-hacking: Do not italicize EXPORT_SYMBOL{,_GPL}() 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-06 15:08:43 -07:00
Bagas Sanjaya b47e2b93aa Documentation: kernel-hacking: Remove current macro annotation
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-06 15:08:43 -07:00
Max Nikulin 3a8501b3a4 docs: admin: devices: remove /dev/cdwriter
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-06 15:06:30 -07:00
Akiyoshi Kurita ae4f42ea4c docs: keystone: fix typo in knav-qmss documentation
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-06 15:03:19 -07:00
Sasha Levin 78d979db6c docs: add AI Coding Assistants documentation
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-06 14:55:06 -07:00
SeongJae Park 57a63f6549 Docs/translations/ko_KR: remove memory-barriers
The memory-barriers.txt Korean translation is quite outdated.  The last
update on the translation was made on 2022-10-10, by commit ee5a86f451
("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-06 14:53:51 -07:00
SeongJae Park 8a12e3fbf2 docs: submitting-patches: suggest adding previous version links
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-06 14:52:48 -07:00
Vincent Mailhol 90f1d896d5 doc-guide: kernel-doc: specify that W=n does not check header files
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 3a025e1d1c ("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-06 14:42:31 -07:00
Volodymyr Kot 5ce70894f6 Doc: correct spelling and wording mistakes
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-06 14:39:58 -07:00
Vincent Mailhol 4971ca2007 docs: process: email-client: add Thunderbird "Toggle Line Wrap" extension
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 e0e34e977a ("Documentation/email-clients.txt:
update Thunderbird docs with wordwrap plugin") but then removed in commit
f9a0974d3f ("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-06 14:38:28 -07:00
Mustafa Elrasheid 8ee50b15d2 docs: Makefile: wrap SPHINXDIRS help text
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-06 14:37:08 -07:00
Randy Dunlap e970637707 docs: find-unused-docs.sh: fixup directory usage
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: 184414c6a6 ("docs: move find-unused-docs.sh to tools/docs")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Fixes: 184414c6a6 (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-06 14:36:07 -07:00
Masaharu Noguchi 7f3f258daf docs/ja_JP: fix typos in submit-checklist.rst
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-06 14:34:43 -07:00
Masaharu Noguchi c7bba35efa docs/ja_JP: fix translation of freestanding C environment
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-06 14:33:30 -07:00
Masaharu Noguchi b09ee709a9 docs/ja_JP: fix typos and duplicated phrases in kernel development guide
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>
2026-01-06 14:33:30 -07:00
Lukas Bulwahn 7f3c3a0a91 MAINTAINERS: Add doc files on real-time support to Real-time Linux
Commit f51fe3b7e4 ("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-22 15:33:40 -07:00
Lukas Bulwahn 6c95f2d67f Documentation: update config name in real-time architecture support
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>
2025-12-22 15:33:40 -07:00
Sebastian Andrzej Siewior 7548c69f51 Documentation: Add some hardware hints for real-time
Some thoughts on hardware that is used for real-time workload. Certainly
not complete but should cover some of the import topics such as:

- Main memory, caches and the possiblie control given by the hardware.
- What could happen by putting critical hardware behind USB or VirtIO.
- Allowing real-time tasks to consume the CPU entirely without giving
  the system some time to breath.
- Networking with what the kernel provides.

Reviewed-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251127154343.292156-2-bigeasy@linutronix.de>
2025-12-22 15:33:40 -07:00
Willy Tarreau ceddb2c001 Documentation: insist on the plain-text requirement for security reports
As the trend of AI-generated reports is growing, the trend of unreadable
reports in gimmicky formats is following, and we cannot request that
developers rely on online viewers to be able to read a security report
full for formatting tags. Let's just insist on the plain text requirement
a bit more.

Signed-off-by: Willy Tarreau <w@1wt.eu>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251129141741.19046-1-w@1wt.eu>
2025-12-22 15:32:03 -07:00
Uwe Kleine-König 273aa250f1 Documentation: Improve wording on requirements for a free Nitrokey
"listed in MAINTAINERS" is not enough to qualify for the free Nitrokey
Start. You have to be listed in an M: entry. Mention that to reduce
confusion for reviewers who wonder why their application fails.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@baylibre.com>
Reviewed-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251203074349.1826233-2-u.kleine-koenig@baylibre.com>
2025-12-22 15:30:51 -07:00
Geert Uytterhoeven 135739a2a9 Documentation: mailbox: mbox_chan_ops.flush() is optional
When the optional .flush() method was added to the mbox_chan structure,
the documentation was not updated.

Fixes: a8803d7421 ("mailbox: Support blocking transfers in atomic context")
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <6a50a5d4f0d0da26e5cccf348550879e53792e6e.1764861174.git.geert+renesas@glider.be>
2025-12-22 15:30:31 -07:00
Soham Metha 7508b208f1 Documentation/rv: Fix dead link to monitor_synthesis.rst
The file 'da_monitor_synthesis.rst' was renamed to 'monitor_synthesis.rst' in
commit f40a7c0602
("Documentation/rv: Prepare monitor synthesis document for LTL inclusion").

Signed-off-by: Soham Metha <sohammetha01@gmail.com>
Fixes: f40a7c0602 ("Documentation/rv: Prepare monitor synthesis document for LTL inclusion")
Acked-by: Gabriele Monaco <gmonaco@redhat.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251204032452.9523-1-sohammetha01@gmail.com>
2025-12-22 15:30:26 -07:00
Shubham Sharma 1de54df949 Documentation: arm: keystone: update DT binding reference
Update the device tree binding reference from .txt to YAML.
Binding was converted in commit 20b3c9a403 ("dt-bindings: arm: Convert ti,keystone to DT schema")
and moved to Documentation/devicetree/bindings/arm/ti/ti,keystone.yaml.

Signed-off-by: Shubham Sharma <slopixelz@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251207195632.68681-1-slopixelz@gmail.com>
2025-12-22 15:20:05 -07:00