netdev - [PATCH net-next 1/5] net: netdevice.h: Document proto_down

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-Id: <20200920171703.3692328-2-andrew@lunn.ch>
Date:   Sun, 20 Sep 2020 19:16:59 +0200
From:   Andrew Lunn <andrew@...n.ch>
To:     David Miller <davem@...emloft.net>
Cc:     netdev <netdev@...r.kernel.org>,
        Florian Fainelli <f.fainelli@...il.com>,
        Heiner Kallweit <hkallweit1@...il.com>,
        Andrew Lunn <andrew@...n.ch>,
        Roopa Prabhu <roopa@...ulusnetworks.com>
Subject: [PATCH net-next 1/5] net: netdevice.h: Document proto_down_reason

Fix the Sphinx warning:

./include/linux/netdevice.h:2162: warning: Function parameter or member
'proto_down_reason' not described in 'net_device'

by adding the needed documentation.

Cc: Roopa Prabhu <roopa@...ulusnetworks.com>
Signed-off-by: Andrew Lunn <andrew@...n.ch>
---
 include/linux/netdevice.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index fef0eb96cf69..9ea53cb92766 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -1774,6 +1774,7 @@ enum netdev_priv_flags {
  *	@qdisc_hash:		qdisc hash table
  *	@watchdog_timeo:	Represents the timeout that is used by
  *				the watchdog (see dev_watchdog())
+ *	@proto_down_reason:	Reason protocol is holding an interface down
  *	@watchdog_timer:	List of timers
  *
  *	@pcpu_refcnt:		Number of references to this device
-- 
2.28.0