net: core: document two new elements of struct net_device
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Fri, 2 Oct 2020 05:49:45 +0000 (07:49 +0200)
committerDavid S. Miller <davem@davemloft.net>
Fri, 2 Oct 2020 22:15:56 +0000 (15:15 -0700)
As warned by "make htmldocs", there are two new struct elements
that aren't documented:

../include/linux/netdevice.h:2159: warning: Function parameter or member 'unlink_list' not described in 'net_device'
../include/linux/netdevice.h:2159: warning: Function parameter or member 'nested_level' not described in 'net_device'

Fixes: 1fc70edb7d7b ("net: core: add nested_level variable in net_device")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
include/linux/netdevice.h

index 9fdb3eb..18dec08 100644 (file)
@@ -1851,6 +1851,11 @@ enum netdev_priv_flags {
  *     @udp_tunnel_nic:        UDP tunnel offload state
  *     @xdp_state:             stores info on attached XDP BPF programs
  *
+ *     @nested_level:  Used as as a parameter of spin_lock_nested() of
+ *                     dev->addr_list_lock.
+ *     @unlink_list:   As netif_addr_lock() can be called recursively,
+ *                     keep a list of interfaces to be deleted.
+ *
  *     FIXME: cleanup struct net_device such that network protocol info
  *     moves out.
  */