diff mbox series

[RESEND,3/3] net: core: fix some kernel-doc markups

Message ID 492b5ee3aca655ffad6e95e61d9b4019e69b8e3a.1603705472.git.mchehab+huawei@kernel.org
State Superseded
Headers show
Series Fix wrong identifiers on kernel-doc markups | expand

Commit Message

Mauro Carvalho Chehab Oct. 26, 2020, 9:47 a.m. UTC
Some identifiers have different names between their prototypes
and the kernel-doc markup.

In the specific case of netif_subqueue_stopped(), keep the
current markup for __netif_subqueue_stopped(), adding a
new one for netif_subqueue_stopped().

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 include/linux/netdevice.h | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

Comments

Jakub Kicinski Oct. 27, 2020, 3:06 a.m. UTC | #1
On Mon, 26 Oct 2020 10:47:38 +0100 Mauro Carvalho Chehab wrote:
> Some identifiers have different names between their prototypes

> and the kernel-doc markup.

> 

> In the specific case of netif_subqueue_stopped(), keep the

> current markup for __netif_subqueue_stopped(), adding a

> new one for netif_subqueue_stopped().

> 

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>


> @@ -3590,6 +3590,13 @@ static inline bool __netif_subqueue_stopped(const struct net_device *dev,

>  	return netif_tx_queue_stopped(txq);

>  }

>  

> +/**

> + *	netif_subqueue_stopped - test status of subqueue

> + *	@dev: network device

> + *	@skb: sub queue buffer pointer


Ah, no: "socket buffer from which to get the mapping"

> + *

> + * Check individual transmit queue of a device with multiple transmit queues.

> + */

>  static inline bool netif_subqueue_stopped(const struct net_device *dev,

>  					  struct sk_buff *skb)

>  {
diff mbox series

Patch

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index 964b494b0e8d..db79ab7580dd 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -1490,7 +1490,7 @@  struct net_device_ops {
 };
 
 /**
- * enum net_device_priv_flags - &struct net_device priv_flags
+ * enum netdev_priv_flags - &struct net_device priv_flags
  *
  * These are the &struct net_device, they are only set internally
  * by drivers and used in the kernel. These flags are invisible to
@@ -3576,7 +3576,7 @@  static inline void netif_stop_subqueue(struct net_device *dev, u16 queue_index)
 }
 
 /**
- *	netif_subqueue_stopped - test status of subqueue
+ *	__netif_subqueue_stopped - test status of subqueue
  *	@dev: network device
  *	@queue_index: sub queue index
  *
@@ -3590,6 +3590,13 @@  static inline bool __netif_subqueue_stopped(const struct net_device *dev,
 	return netif_tx_queue_stopped(txq);
 }
 
+/**
+ *	netif_subqueue_stopped - test status of subqueue
+ *	@dev: network device
+ *	@skb: sub queue buffer pointer
+ *
+ * Check individual transmit queue of a device with multiple transmit queues.
+ */
 static inline bool netif_subqueue_stopped(const struct net_device *dev,
 					  struct sk_buff *skb)
 {