From: Jakub Kicinski <kuba@kernel.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: netdev@vger.kernel.org, Alexandra Winter <wintera@linux.ibm.com>,
Thorsten Winkler <twinkler@linux.ibm.com>,
linux-s390@vger.kernel.org,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Paolo Abeni <pabeni@redhat.com>, Simon Horman <horms@kernel.org>
Subject: Re: [PATCH net-next] net/iucv: clean up iucv kernel-doc warnings
Date: Sat, 31 Jan 2026 13:11:31 -0800 [thread overview]
Message-ID: <20260131131131.0d854805@kernel.org> (raw)
In-Reply-To: <20260130054759.1301608-1-rdunlap@infradead.org>
On Thu, 29 Jan 2026 21:47:59 -0800 Randy Dunlap wrote:
> /**
> - * __iucv_message_receive
> + * __iucv_message_receive - Terminates an IUCV path.
AI code review complains this is odd wording since the main body
describes reception not termination.
> * @path: address of iucv path structure
> * @msg: address of iucv msg structure
> * @flags: flags that affect how the message is received (IUCV_IPBUFLST)
> @@ -374,7 +363,7 @@ int __iucv_message_receive(struct iucv_p
> size_t *residual);
>
> /**
> - * iucv_message_reject
> + * iucv_message_reject - Refuses a specified message
> * @path: address of iucv path structure
> * @msg: address of iucv msg structure
> *
> @@ -387,7 +376,7 @@ int __iucv_message_receive(struct iucv_p
> int iucv_message_reject(struct iucv_path *path, struct iucv_message *msg);
>
> /**
> - * iucv_message_reply
> + * iucv_message_reply - Refuses a specified message
Same here, refuses or replies?
> * @path: address of iucv path structure
> * @msg: address of iucv msg structure
> * @flags: how the reply is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST)
In general -- Could we possibly delete the duplicated kdocs in
the header. As clearly shown by this patch it's double the work
and kernel-doc will be able to find the definition wherever it is.
Kernel coding guide recommends kdoc next to definition.
--
pw-bot: cr
next prev parent reply other threads:[~2026-01-31 21:11 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-30 5:47 [PATCH net-next] net/iucv: clean up iucv kernel-doc warnings Randy Dunlap
2026-01-31 21:11 ` Jakub Kicinski [this message]
2026-02-01 0:01 ` Randy Dunlap
2026-02-01 0:49 ` Jakub Kicinski
2026-02-01 1:31 ` Randy Dunlap
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=20260131131131.0d854805@kernel.org \
--to=kuba@kernel.org \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=horms@kernel.org \
--cc=linux-s390@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=rdunlap@infradead.org \
--cc=twinkler@linux.ibm.com \
--cc=wintera@linux.ibm.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox