Re: [PATCH] docs: process: discourage pointless boilerplate kdoc
From: Joe Damato <hidden>
Date: 2025-06-15 07:37:18
Also in:
linux-doc, workflows
From: Joe Damato <hidden>
Date: 2025-06-15 07:37:18
Also in:
linux-doc, workflows
On Sat, Jun 14, 2025 at 01:42:57PM -0700, Jakub Kicinski wrote:
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> --- CC: corbet@lwn.net CC: workflows@vger.kernel.org CC: linux-doc@vger.kernel.org --- Documentation/process/coding-style.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
I suppose I am guilty of this ;) Reviewed-by: Joe Damato <redacted>