skbuff.h: fix kernel-doc warning for headers_end
Subsystems (2)
PATCH 1/1 skbuff.h: fix kernel-doc warning for headers_end
From: Randy Dunlap <[email protected]>
Fix kernel-doc warning in <linux/skbuff.h> by making both headers_start and headers_end private fields.
Warning(..//include/linux/skbuff.h:654): No description found for parameter 'headers_end[0]'
Signed-off-by Randy Dunlap <[email protected]>
--- include/linux/skbuff.h | 4 ++++ 1 file changed, 4 insertions(+)
Or I can document those two fields if you would rather not have them marked as private...
include/linux/skbuff.h +4 -0
@@ -557,7 +557,9 @@ struct sk_buff {/* fields enclosed in headers_start/headers_end are copied * using a single memcpy() in __copy_skb_header() */ +/* private: */ __u32 headers_start[0 ]; +/* public: */ /* if you move pkt_type around you also must adapt those constants */ #ifdef __BIG_ENDIAN_BITFIELD
@@ -642,7 +644,9 @@ struct sk_buff {__u16 network_header;__u16 mac_header; +/* private: */ __u32 headers_end[0 ]; +/* public: */ /* These elements must be at the end, see alloc_skb() for details. */ sk_buff_data_t tail;
From: Randy Dunlap <[email protected]>
Date: Sun, 26 Oct 2014 19:14:06 -0700
Quoted 8 lines
From: Randy Dunlap <[email protected]>
Fix kernel-doc warning in <
linux/skbuff.h> by making bothheaders_startandheaders_endprivate fields.Warning(..//include/linux/skbuff.h:654): No description found for parameter 'headers_end[0]'
Signed-off-by Randy Dunlap <[email protected]>
Applied, thanks a lot Randy.