From: David Miller <davem@davemloft.net>
To: briannorris@chromium.org
Cc: netdev@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH net-next] net/skbuff: fix up kernel-doc placement
Date: Tue, 12 Feb 2019 09:55:20 -0800 (PST) [thread overview]
Message-ID: <20190212.095520.2293054975357585380.davem@davemloft.net> (raw)
In-Reply-To: <20190211210225.132282-1-briannorris@chromium.org>
From: Brian Norris <briannorris@chromium.org>
Date: Mon, 11 Feb 2019 13:02:25 -0800
> There are several skb_* functions where the locked and unlocked
> functions are confusingly documented. For several of them, the
> kernel-doc for the unlocked version is placed above the locked version,
> which to the casual reader makes it seems like the locked version "takes
> no locks and you must therefore hold required locks before calling it."
>
> One can see, for example, that this link claims to document
> skb_queue_head(), while instead describing __skb_queue_head().
>
> https://www.kernel.org/doc/html/latest/networking/kapi.html#c.skb_queue_head
>
> The correct documentation for skb_queue_head() is also included further
> down the page.
>
> This diff tested via:
>
> $ scripts/kernel-doc -rst include/linux/skbuff.h net/core/skbuff.c
>
> No new warnings were seen, and the output makes a little more sense.
>
> Signed-off-by: Brian Norris <briannorris@chromium.org>
Applied, thanks Brian.
prev parent reply other threads:[~2019-02-12 17:55 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-11 21:02 [PATCH net-next] net/skbuff: fix up kernel-doc placement Brian Norris
2019-02-12 17:55 ` David Miller [this message]
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=20190212.095520.2293054975357585380.davem@davemloft.net \
--to=davem@davemloft.net \
--cc=briannorris@chromium.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox