net: fix kdoc on __dev_queue_xmit()
Subsystems (2)
Jakub Kicinski
maintainerPATCH 1/1 net: fix kdoc on __dev_queue_xmit()
Commit c526fd8f9f4f21 ("net: inline dev_queue_xmit()") exported __dev_queue_xmit(), now it's being rendered in html docs, triggering:
Documentation/networking/kapi:92: net/core/dev.c:4101: WARNING: Missing matching underline for section title overline.
---
CC: [email protected]
CC: Akira Yokosawa <[email protected]>
CC: Bagas Sanjaya <[email protected]>
CC: Ben Greear <[email protected]>
--- net/core/dev.c | 35 +++++++++++++++-------------------- 1 file changed, 15 insertions(+), 20 deletions(-)
net/core/dev.c +15 -20
@@ -4131,30 +4131,25 @@ struct netdev_queue *netdev_core_pick_tx(struct net_device *dev, }/** -* __dev_queue_xmit - transmit a buffer -* @skb: buffer to transmit -* @sb_dev: suboordinate device used for L2 forwarding offload -* -* Queue a buffer for transmission to a network device. The caller must -* have set the device and priority and built the buffer before calling -* this function. The function can be called from an interrupt. +* __dev_queue_xmit() - transmit a buffer +* @skb: buffer to transmit +* @sb_dev: suboordinate device used for L2 forwarding offload * -* A negative errno code is returned on a failure. A success does not -* guarantee the frame will be transmitted as it may be dropped due -* to congestion or traffic shaping. +* Queue a buffer for transmission to a network device. The caller must +* have set the device and priority and built the buffer before calling +* this function. The function can be called from an interrupt. * -* ----------------------------------------------------------------------------------- -* I notice this method can also return errors from the queue disciplines, -* including NET_XMIT_DROP, which is a positive value. So, errors can also -* be positive. +* When calling this method, interrupts MUST be enabled. This is because +* the BH enable code must have IRQs enabled so that it will not deadlock. * -* Regardless of the return value, the skb is consumed, so it is currently -* difficult to retry a send to this method. (You can bump the ref count -* before sending to hold a reference for retry if you are careful.) +* Regardless of the return value, the skb is consumed, so it is currently +* difficult to retry a send to this method. (You can bump the ref count +* before sending to hold a reference for retry if you are careful.) * -* When calling this method, interrupts MUST be enabled. This is because -* the BH enable code must have IRQs enabled so that it will not deadlock. -* --BLG +* Return: +* * 0 - buffer successfully transmitted +* * positive qdisc return code - NET_XMIT_DROP etc. +* * negative errno - other errors */ int __dev_queue_xmit (struct sk_buff *skb,struct net_device *sb_dev) {
Signature · 1 line
2.34.3
This patch was applied to netdev/net-next.git (master) by Jakub Kicinski <[email protected]>:
Hello:
This patch was applied to netdev/net-next.git (master) by Jakub Kicinski <[email protected]>:
Quoted 11 lines · On Mon, 9 May 2022 10:04:12 -0700 you wrote:
Commit
c526fd8f9f4f21("net: inlinedev_queue_xmit()") exported__dev_queue_xmit(), now it's being rendered in html docs, triggering:
Documentation/networking/kapi:92:net/core/dev.c:4101: WARNING: Missing matching underline for section title overline.Reported-by Stephen Rothwell <[email protected]>Fixes c526fd8f9f4f21 ("net: inline dev_queue_xmit()")Signed-off-by Jakub Kicinski <[email protected]>[...]
Here is the summary with links:
- [net-next] net: fix kdoc on __dev_queue_xmit()
https://git.kernel.org/netdev/net-next/c/be76955dea93
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html