From: Jakub Kicinski <kuba@kernel•org>
To: "Russell King (Oracle)" <linux@armlinux•org.uk>,
Jonathan Corbet <corbet@lwn•net>
Cc: davem@davemloft•net, netdev@vger•kernel.org, edumazet@google•com,
pabeni@redhat•com, pablo@netfilter•org, richardcochran@gmail•com,
johannes@sipsolutions•net, loic.poulain@linaro•org,
ryazanov.s.a@gmail•com, dsahern@kernel•org,
wintera@linux•ibm.com, hawk@kernel•org,
ilias.apalodimas@linaro•org, jhs@mojatatu•com, jiri@resnulli•us,
ecree.xilinx@gmail•com, przemyslaw.kitszel@intel•com,
netfilter-devel@vger•kernel.org, linux-wireless@vger•kernel.org,
linux-doc@vger•kernel.org
Subject: Re: [PATCH net-next] net: reformat kdoc return statements
Date: Mon, 18 Nov 2024 16:33:08 -0800 [thread overview]
Message-ID: <20241118163308.318d8a6b@kernel.org> (raw)
In-Reply-To: <ZzjHH-L-ylLe0YhU@shell.armlinux.org.uk>
On Sat, 16 Nov 2024 16:23:59 +0000 Russell King (Oracle) wrote:
> On Fri, Nov 15, 2024 at 08:36:12AM -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).
>
> I wonder about this... I suspect it's going to be a constant battle to
> ensure that docs use Return: or Returns: because it's not "natural"
> when writing documentation.
>
> Maybe the tooling should accept a sentence starting "Return(s?)" and
> convert it to "Return(s):" in generated documentation?
I missed this merge window, so we have time, let's ask Jon.
Jon, do you have a preference on making the kernel-doc formatting
accept "* Return" without the colon? vs fixing all the mis-formatting?
Looks like we have roughly 100 of those in networking headers
(just counting those under include/).
FWIW we catch new instances of the missing return problem, so it
shouldn't be getting worse.
next prev parent reply other threads:[~2024-11-19 0:33 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-11-15 16:36 [PATCH net-next] net: reformat kdoc return statements Jakub Kicinski
2024-11-15 16:45 ` Johannes Berg
2024-11-15 18:46 ` Jakub Kicinski
2024-11-16 14:28 ` Richard Cochran
2024-11-16 16:23 ` Russell King (Oracle)
2024-11-19 0:33 ` Jakub Kicinski [this message]
2024-11-19 14:42 ` Jonathan Corbet
2024-11-18 0:51 ` Sergey Ryazanov
2024-11-18 10:32 ` Edward Cree
2024-11-19 9:07 ` Alexandra Winter
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=20241118163308.318d8a6b@kernel.org \
--to=kuba@kernel$(echo .)org \
--cc=corbet@lwn$(echo .)net \
--cc=davem@davemloft$(echo .)net \
--cc=dsahern@kernel$(echo .)org \
--cc=ecree.xilinx@gmail$(echo .)com \
--cc=edumazet@google$(echo .)com \
--cc=hawk@kernel$(echo .)org \
--cc=ilias.apalodimas@linaro$(echo .)org \
--cc=jhs@mojatatu$(echo .)com \
--cc=jiri@resnulli$(echo .)us \
--cc=johannes@sipsolutions$(echo .)net \
--cc=linux-doc@vger$(echo .)kernel.org \
--cc=linux-wireless@vger$(echo .)kernel.org \
--cc=linux@armlinux$(echo .)org.uk \
--cc=loic.poulain@linaro$(echo .)org \
--cc=netdev@vger$(echo .)kernel.org \
--cc=netfilter-devel@vger$(echo .)kernel.org \
--cc=pabeni@redhat$(echo .)com \
--cc=pablo@netfilter$(echo .)org \
--cc=przemyslaw.kitszel@intel$(echo .)com \
--cc=richardcochran@gmail$(echo .)com \
--cc=ryazanov.s.a@gmail$(echo .)com \
--cc=wintera@linux$(echo .)ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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