OSDN Git Service

net/skbuff: fix up kernel-doc placement
authorBrian Norris <briannorris@chromium.org>
Mon, 11 Feb 2019 21:02:25 +0000 (13:02 -0800)
committerDavid S. Miller <davem@davemloft.net>
Tue, 12 Feb 2019 17:54:37 +0000 (12:54 -0500)
commit4ea7b0cf0da7494d5c7b8dc328493c50640d0cbc
treedd7a2897f1905f2b2406aebd8dea0f98b2a325d4
parent317d8e2f38a4ca1f6dd71176303a810da797a5fa
net/skbuff: fix up kernel-doc placement

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>
Signed-off-by: David S. Miller <davem@davemloft.net>
include/linux/skbuff.h