diff mbox series

[net-next,1/5] net: netdevice.h: Document proto_down_reason

Message ID 20200920171703.3692328-2-andrew@lunn.ch
State Changes Requested
Delegated to: David Miller
Headers show
Series [net-next,1/5] net: netdevice.h: Document proto_down_reason | expand

Commit Message

Andrew Lunn Sept. 20, 2020, 5:16 p.m. UTC
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@cumulusnetworks.com>
Signed-off-by: Andrew Lunn <andrew@lunn.ch>
---
 include/linux/netdevice.h | 1 +
 1 file changed, 1 insertion(+)

Comments

Florian Fainelli Sept. 20, 2020, 9:07 p.m. UTC | #1
On 9/20/2020 10:16 AM, Andrew Lunn wrote:
> 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@cumulusnetworks.com>
> Signed-off-by: Andrew Lunn <andrew@lunn.ch>

Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
diff mbox series

Patch

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