netdev - [PATCH net-next] net: add missing htmldocs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20211204015741.3358725-1-eric.dumazet@gmail.com>
Date:   Fri,  3 Dec 2021 17:57:41 -0800
From:   Eric Dumazet <eric.dumazet@...il.com>
To:     "David S . Miller" <davem@...emloft.net>,
        Jakub Kicinski <kuba@...nel.org>
Cc:     netdev <netdev@...r.kernel.org>,
        Eric Dumazet <edumazet@...gle.com>,
        Eric Dumazet <eric.dumazet@...il.com>
Subject: [PATCH net-next] net: add missing htmldocs

From: Eric Dumazet <edumazet@...gle.com>

include/linux/netdevice.h:2278: warning: Function parameter or member 'refcnt_tracker' not described in 'net_device'
include/net/devlink.h:679: warning: Function parameter or member 'dev_tracker' not described in 'devlink_trap_metadata'
include/linux/netdevice.h:2283: warning: Function parameter or member 'refcnt_tracker' not described in 'net_device'
include/linux/mroute_base.h:40: warning: Function parameter or member 'dev_tracker' not described in 'vif_device'

Reported-by: Jakub Kicinski <kuba@...nel.org>
Signed-off-by: Eric Dumazet <edumazet@...gle.com>
---

This is the followup patch.

If you prefer I can insert it the next round of patches.

 include/linux/mroute_base.h | 1 +
 include/linux/netdevice.h   | 2 ++
 include/net/devlink.h       | 1 +
 3 files changed, 4 insertions(+)

diff --git a/include/linux/mroute_base.h b/include/linux/mroute_base.h
index 91ab497bd3e579b9d78f423d8c28310cf6b07f58..e05ee9f001ffbf30f7b26ab5555e2db5cc058560 100644
--- a/include/linux/mroute_base.h
+++ b/include/linux/mroute_base.h
@@ -12,6 +12,7 @@
 /**
  * struct vif_device - interface representor for multicast routing
  * @dev: network device being used
+ * @dev_tracker: refcount tracker for @dev reference
  * @bytes_in: statistic; bytes ingressing
  * @bytes_out: statistic; bytes egresing
  * @pkt_in: statistic; packets ingressing
diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index 990fb906b524860451b32df6b4bf625780b6d9d7..a0ad38ebf8f6c5e98a1a349892553adb13f2dc9f 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -1877,6 +1877,7 @@ enum netdev_ml_priv_type {
  *	@pcpu_refcnt:		Number of references to this device
  *	@dev_refcnt:		Number of references to this device
  *	@todo_list:		Delayed register/unregister
+ *	@refcnt_tracker:	Tracker directory for tracked references to this device
  *	@link_watch_list:	XXX: need comments on this one
  *
  *	@reg_state:		Register/unregister state machine
@@ -1949,6 +1950,7 @@ enum netdev_ml_priv_type {
  *			keep a list of interfaces to be deleted.
  *
  *	@dev_addr_shadow:	Copy of @dev_addr to catch direct writes.
+ *	@linkwatch_dev_tracker: refcount tracker used by linkwatch.
  *
  *	FIXME: cleanup struct net_device such that network protocol info
  *	moves out.
diff --git a/include/net/devlink.h b/include/net/devlink.h
index 09b75fdfa74e268aaeb05ec640fd76ec5ba777ac..00ee43186983679cb835847ce358f04b08b90a48 100644
--- a/include/net/devlink.h
+++ b/include/net/devlink.h
@@ -664,6 +664,7 @@ struct devlink_health_reporter_ops {
  * @trap_name: Trap name.
  * @trap_group_name: Trap group name.
  * @input_dev: Input netdevice.
+ * @dev_tracker: refcount tracker for @input_dev
  * @fa_cookie: Flow action user cookie.
  * @trap_type: Trap type.
  */
-- 
2.34.1.400.ga245620fadb-goog