docs: process: discourage pointless boilerplate kdoc
authorJakub Kicinski <kuba@kernel.org>
Sat, 14 Jun 2025 20:42:57 +0000 (13:42 -0700)
committerJonathan Corbet <corbet@lwn.net>
Sat, 21 Jun 2025 20:14:33 +0000 (14:14 -0600)
commite5880f95a97928308845dc97fdd239605e06e501
tree3f0f5752d4c7093ad8294b4de5f245f56275d60e
parent0242b8b0cc89599b3e4162add672179ce2dd4131
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
Documentation/process/coding-style.rst