twx-linux/Documentation/process
Jakub Kicinski e5880f95a9 docs: process: discourage pointless boilerplate kdoc
It appears that folks "less versed in kernel coding" think that its
good style to document every function, even if they have no useful
information to pass to the future readers of the code. This used
to be just a waste of space, but with increased kdoc format linting
it's also a burden when refactoring the code.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Reviewed-by: Joe Damato <joe@dama.to>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250614204258.61449-1-kuba@kernel.org
2025-06-21 14:14:33 -06:00
..
debugging - The 3 patch series "hung_task: extend blocking task stacktrace dump to 2025-05-31 19:12:53 -07:00
1.Intro.rst docs: Fix conflicting contributor identity info 2025-04-14 10:46:41 -06:00
2.Process.rst Documentation: fix links to mailing list services 2024-07-03 16:52:54 -06:00
3.Early-stage.rst
4.Coding.rst Docs: Move clang-format from process/ to dev-tools/ 2024-06-26 16:36:00 -06:00
5.Posting.rst docs: clarify rules wrt tagging other people 2025-03-17 16:48:18 -06:00
6.Followthrough.rst
7.AdvancedTopics.rst docs: try to encourage (netdev?) reviewers 2023-10-15 14:26:51 +01:00
8.Conclusion.rst
adding-syscalls.rst docs: align with scripts/syscall.tbl migration 2025-05-19 09:09:55 -06:00
applying-patches.rst
backporting.rst docs: fix typos and whitespace in Documentation/process/backporting.rst 2024-11-12 13:22:16 -07:00
botching-up-ioctls.rst
changes.rst docs: Remove reiserfsprogs from dependencies. 2025-06-09 14:53:16 -06:00
code-of-conduct-interpretation.rst Documentation/CoC: Spell out the TAB role in enforcement decisions 2025-03-12 16:31:48 -06:00
code-of-conduct.rst
coding-style.rst docs: process: discourage pointless boilerplate kdoc 2025-06-21 14:14:33 -06:00
contribution-maturity-model.rst
cve.rst Documentation: Document the Linux Kernel CVE process 2024-02-17 14:46:39 +01:00
deprecated.rst
development-process.rst docs: use toctree :caption: and move introduction 2023-11-17 13:05:26 -07:00
email-clients.rst Documentation: remove :kyb: tags 2024-12-11 09:07:39 -07:00
embargoed-hardware-issues.rst Documentation: embargoed-hardware-issues.rst: Remove myself 2025-05-21 14:22:54 +02:00
handling-regressions.rst docs: handling-regressions.rst: recommend using "Closes:" tags 2024-05-30 13:56:06 -06:00
howto.rst Documentation: fix links to mailing list services 2024-07-03 16:52:54 -06:00
index.rst docs: Add debugging section to process 2024-11-22 10:48:12 -07:00
kernel-docs.rst kernel-docs: Add book to process/kernel-docs.rst 2025-02-18 13:24:01 -07:00
kernel-driver-statement.rst
kernel-enforcement-statement.rst
license-rules.rst docs/licensing: Clarify wording about "GPL" and "Proprietary" 2024-11-22 10:44:25 -07:00
maintainer-handbooks.rst
maintainer-kvm-x86.rst
maintainer-netdev.rst docs: netdev: add a note on selftest posting 2025-03-11 13:31:26 +01:00
maintainer-pgp-guide.rst
maintainer-soc-clean-dts.rst docs: process: maintainer-soc-clean-dts: linux-next is decisive 2025-02-26 13:15:57 -06:00
maintainer-soc.rst Documentation/process: maintainer-soc: clarify submitting patches 2024-10-11 09:56:53 +00:00
maintainer-tip.rst Align git commit ID abbreviation guidelines and checks 2024-12-30 11:40:45 -07:00
maintainers.rst
management-style.rst
programming-language.rst
researcher-guidelines.rst Documentation: update mailing list addresses 2024-02-21 13:44:21 -07:00
security-bugs.rst Documentation: Document the Linux Kernel CVE process 2024-02-17 14:46:39 +01:00
stable-api-nonsense.rst
stable-kernel-rules.rst docs: stable-kernel-rules: fix typo sent->send 2024-05-02 10:20:27 -06:00
submit-checklist.rst docs/.../submit-checklist: Use Documentation/admin-guide/abi.rst for cross-ref of README 2025-03-12 16:41:56 -06:00
submitting-patches.rst docs: clarify rules wrt tagging other people 2025-03-17 16:48:18 -06:00
volatile-considered-harmful.rst