Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

net: improve and fix netlink kdoc

Subsequent patch will render the kdoc from
include/uapi/linux/netlink.h into Documentation.
We need to fix the warnings. While at it move
the comments on struct nlmsghdr to a proper
kdoc comment.

Link: https://lore.kernel.org/r/20220819200221.422801-1-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

+16 -5
+16 -5
include/uapi/linux/netlink.h
··· 41 41 __u32 nl_groups; /* multicast groups mask */ 42 42 }; 43 43 44 + /** 45 + * struct nlmsghdr - fixed format metadata header of Netlink messages 46 + * @nlmsg_len: Length of message including header 47 + * @nlmsg_type: Message content type 48 + * @nlmsg_flags: Additional flags 49 + * @nlmsg_seq: Sequence number 50 + * @nlmsg_pid: Sending process port ID 51 + */ 44 52 struct nlmsghdr { 45 - __u32 nlmsg_len; /* Length of message including header */ 46 - __u16 nlmsg_type; /* Message content */ 47 - __u16 nlmsg_flags; /* Additional flags */ 48 - __u32 nlmsg_seq; /* Sequence number */ 49 - __u32 nlmsg_pid; /* Sending process port ID */ 53 + __u32 nlmsg_len; 54 + __u16 nlmsg_type; 55 + __u16 nlmsg_flags; 56 + __u32 nlmsg_seq; 57 + __u32 nlmsg_pid; 50 58 }; 51 59 52 60 /* Flags values */ ··· 345 337 * bitfield32 type (U32) 346 338 * @NL_POLICY_TYPE_ATTR_MASK: mask of valid bits for unsigned integers (U64) 347 339 * @NL_POLICY_TYPE_ATTR_PAD: pad attribute for 64-bit alignment 340 + * 341 + * @__NL_POLICY_TYPE_ATTR_MAX: number of attributes 342 + * @NL_POLICY_TYPE_ATTR_MAX: highest attribute number 348 343 */ 349 344 enum netlink_policy_type_attr { 350 345 NL_POLICY_TYPE_ATTR_UNSPEC,