From: Joe Damato <joe@dama.to>
To: Jakub Kicinski <kuba@kernel.org>
Cc: corbet@lwn.net, workflows@vger.kernel.org,
linux-doc@vger.kernel.org, netdev@vger.kernel.org
Subject: Re: [PATCH] docs: process: discourage pointless boilerplate kdoc
Date: Sun, 15 Jun 2025 10:37:13 +0300 [thread overview]
Message-ID: <aE54KSsCaTY5cxri@MacBook-Air.local> (raw)
In-Reply-To: <20250614204258.61449-1-kuba@kernel.org>
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 <joe@dama.to>
next prev parent reply other threads:[~2025-06-15 7:37 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-14 20:42 [PATCH] docs: process: discourage pointless boilerplate kdoc Jakub Kicinski
2025-06-15 7:37 ` Joe Damato [this message]
2025-06-21 20:15 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aE54KSsCaTY5cxri@MacBook-Air.local \
--to=joe@dama.to \
--cc=corbet@lwn.net \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.