if_vlan: fix kdoc warnings
Subsystems (2)
Jakub Kicinski
maintainerPATCH 1/1 if_vlan: fix kdoc warnings
While merging net to net-next I noticed that the kdoc above __vlan_get_protocol_offset() has the wrong function name. Fix that and all the other kdoc warnings in this file.
Signed-off-by Jakub Kicinski <[email protected]>
--- include/linux/if_vlan.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)
include/linux/if_vlan.h +11 -2
@@ -176,6 +176,7 @@ struct netpoll;* @real_dev_addr: address of underlying netdevice * @dent: proc dir entry * @vlan_pcpu_stats: ptr to percpu rx stats +* @netpoll: netpoll instance "propagated" down to @real_dev */ struct vlan_dev_priv {unsigned int nr_ingress_mappings;
@@ -414,6 +415,8 @@ static inline int __vlan_insert_tag(struct sk_buff *skb,* doesn't have to worry about freeing the original skb. * * Does not change skb->protocol so this function can be used during receive. +* +* Return: modified @skb on success, NULL on error (@skb is freed). */ static inline struct sk_buff *vlan_insert_inner_tag(struct sk_buff *skb, __be16 vlan_proto,
@@ -443,6 +446,8 @@ static inline struct sk_buff *vlan_insert_inner_tag(struct sk_buff *skb,* doesn't have to worry about freeing the original skb. * * Does not change skb->protocol so this function can be used during receive. +* +* Return: modified @skb on success, NULL on error (@skb is freed). */ static inline struct sk_buff *vlan_insert_tag (struct sk_buff *skb,__be16 vlan_proto,u16 vlan_tci)
@@ -461,6 +466,8 @@ static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,* * Following the skb_unshare() example, in case of error, the calling function * doesn't have to worry about freeing the original skb. +* +* Return: modified @skb on success, NULL on error (@skb is freed). */ static inline struct sk_buff *vlan_insert_tag_set_proto(struct sk_buff *skb, __be16 vlan_proto,
@@ -582,7 +589,7 @@ static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci) }/** -* vlan_get_protocol - get protocol EtherType. +* __vlan_get_protocol_offset() - get protocol EtherType. * @skb: skbuff to query * @type: first vlan protocol * @mac_offset: MAC offset
@@ -808,9 +815,11 @@ static inline netdev_features_t vlan_features_check(struct sk_buff *skb,* @h1: Pointer to vlan header * @h2: Pointer to vlan header * -* Compare two vlan headers, returns 0 if equal. +* Compare two vlan headers. * * Please note that alignment of h1 & h2 are only guaranteed to be 16 bits. +* +* Return: 0 if equal, arbitrary non-zero value if not equal. */ static inline unsigned long compare_vlan_header (const struct vlan_hdr *h1,const struct vlan_hdr *h2)
Signature · 1 line
2.47.1
Quoted 5 lines · Jakub Kicinski
While merging net to net-next I noticed that the kdoc above
__vlan_get_protocol_offset()has the wrong function name. Fix that and all the other kdoc warnings in this file.Signed-off-by Jakub Kicinski <[email protected]>
Reviewed-by Simon Horman <[email protected]>
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Hello:
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Quoted 8 lines · On Mon, 6 Jan 2025 09:46:20 -0800 you wrote:
While merging net to net-next I noticed that the kdoc above
__vlan_get_protocol_offset()has the wrong function name. Fix that and all the other kdoc warnings in this file.Signed-off-by Jakub Kicinski <[email protected]>--- include/linux/if_vlan.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)
Here is the summary with links:
- [net-next] if_vlan: fix kdoc warnings
https://git.kernel.org/netdev/net-next/c/d8c2e5f33ace
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html