From: Pablo Neira Ayuso <pablo@netfilter.org>
To: Jakub Kicinski <kuba@kernel.org>
Cc: davem@davemloft.net, netdev@vger.kernel.org, edumazet@google.com,
pabeni@redhat.com, Johannes Berg <johannes@sipsolutions.net>,
Richard Cochran <richardcochran@gmail.com>,
Sergey Ryazanov <ryazanov.s.a@gmail.com>,
Edward Cree <ecree.xilinx@gmail.com>,
Alexandra Winter <wintera@linux.ibm.com>,
loic.poulain@linaro.org, dsahern@kernel.org, hawk@kernel.org,
ilias.apalodimas@linaro.org, jhs@mojatatu.com, jiri@resnulli.us,
przemyslaw.kitszel@intel.com, netfilter-devel@vger.kernel.org,
linux-wireless@vger.kernel.org
Subject: Re: [PATCH net-next v2] net: reformat kdoc return statements
Date: Fri, 6 Dec 2024 11:18:18 +0100 [thread overview]
Message-ID: <Z1LPaoazEajgMhp_@calendula> (raw)
In-Reply-To: <20241205165914.1071102-1-kuba@kernel.org>
On Thu, Dec 05, 2024 at 08:59:14AM -0800, Jakub Kicinski wrote:
> kernel-doc -Wall warns about missing Return: statement for non-void
> functions. We have a number of kdocs in our headers which are missing
> the colon, IOW they use
> * Return some value
> or
> * Returns some value
>
> Having the colon makes some sense, it should help kdoc parser avoid
> false positives. So add them. This is mostly done with a sed script,
> and removing the unnecessary cases (mostly the comments which aren't
> kdoc).
>
> Acked-by: Johannes Berg <johannes@sipsolutions.net>
> Acked-by: Richard Cochran <richardcochran@gmail.com>
> Acked-by: Sergey Ryazanov <ryazanov.s.a@gmail.com>
> Reviewed-by: Edward Cree <ecree.xilinx@gmail.com>
> Acked-by: Alexandra Winter <wintera@linux.ibm.com>
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
For the netfilter chunks:
Acked-by: Pablo Neira Ayuso <pablo@netfilter.org>
next prev parent reply other threads:[~2024-12-06 10:18 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-05 16:59 [PATCH net-next v2] net: reformat kdoc return statements Jakub Kicinski
2024-12-06 10:18 ` Pablo Neira Ayuso [this message]
2024-12-06 15:08 ` Przemek Kitszel
2024-12-09 23:20 ` patchwork-bot+netdevbpf
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=Z1LPaoazEajgMhp_@calendula \
--to=pablo@netfilter.org \
--cc=davem@davemloft.net \
--cc=dsahern@kernel.org \
--cc=ecree.xilinx@gmail.com \
--cc=edumazet@google.com \
--cc=hawk@kernel.org \
--cc=ilias.apalodimas@linaro.org \
--cc=jhs@mojatatu.com \
--cc=jiri@resnulli.us \
--cc=johannes@sipsolutions.net \
--cc=kuba@kernel.org \
--cc=linux-wireless@vger.kernel.org \
--cc=loic.poulain@linaro.org \
--cc=netdev@vger.kernel.org \
--cc=netfilter-devel@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=przemyslaw.kitszel@intel.com \
--cc=richardcochran@gmail.com \
--cc=ryazanov.s.a@gmail.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;
as well as URLs for NNTP newsgroup(s).