Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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.
Reviewed-by: Simon Horman <horms@kernel.org>
Link: https://patch.msgid.link/20250106174620.1855269-1-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
+11
-2
+11
-2
include/linux/if_vlan.h
+11
-2
include/linux/if_vlan.h
···
176
176
* @real_dev_addr: address of underlying netdevice
177
177
* @dent: proc dir entry
178
178
* @vlan_pcpu_stats: ptr to percpu rx stats
179
+
* @netpoll: netpoll instance "propagated" down to @real_dev
179
180
*/
180
181
struct vlan_dev_priv {
181
182
unsigned int nr_ingress_mappings;
···
415
414
* doesn't have to worry about freeing the original skb.
416
415
*
417
416
* Does not change skb->protocol so this function can be used during receive.
417
+
*
418
+
* Return: modified @skb on success, NULL on error (@skb is freed).
418
419
*/
419
420
static inline struct sk_buff *vlan_insert_inner_tag(struct sk_buff *skb,
420
421
__be16 vlan_proto,
···
446
443
* doesn't have to worry about freeing the original skb.
447
444
*
448
445
* Does not change skb->protocol so this function can be used during receive.
446
+
*
447
+
* Return: modified @skb on success, NULL on error (@skb is freed).
449
448
*/
450
449
static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,
451
450
__be16 vlan_proto, u16 vlan_tci)
···
466
461
*
467
462
* Following the skb_unshare() example, in case of error, the calling function
468
463
* doesn't have to worry about freeing the original skb.
464
+
*
465
+
* Return: modified @skb on success, NULL on error (@skb is freed).
469
466
*/
470
467
static inline struct sk_buff *vlan_insert_tag_set_proto(struct sk_buff *skb,
471
468
__be16 vlan_proto,
···
589
582
}
590
583
591
584
/**
592
-
* vlan_get_protocol - get protocol EtherType.
585
+
* __vlan_get_protocol_offset() - get protocol EtherType.
593
586
* @skb: skbuff to query
594
587
* @type: first vlan protocol
595
588
* @mac_offset: MAC offset
···
815
808
* @h1: Pointer to vlan header
816
809
* @h2: Pointer to vlan header
817
810
*
818
-
* Compare two vlan headers, returns 0 if equal.
811
+
* Compare two vlan headers.
819
812
*
820
813
* Please note that alignment of h1 & h2 are only guaranteed to be 16 bits.
814
+
*
815
+
* Return: 0 if equal, arbitrary non-zero value if not equal.
821
816
*/
822
817
static inline unsigned long compare_vlan_header(const struct vlan_hdr *h1,
823
818
const struct vlan_hdr *h2)