Netdev Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Andrew Lunn <andrew@lunn.ch>
To: David Miller <davem@davemloft.net>
Cc: netdev <netdev@vger.kernel.org>,
	Florian Fainelli <f.fainelli@gmail.com>,
	Heiner Kallweit <hkallweit1@gmail.com>,
	Andrew Lunn <andrew@lunn.ch>,
	Roopa Prabhu <roopa@cumulusnetworks.com>
Subject: [PATCH net-next 1/5] net: netdevice.h: Document proto_down_reason
Date: Sun, 20 Sep 2020 19:16:59 +0200	[thread overview]
Message-ID: <20200920171703.3692328-2-andrew@lunn.ch> (raw)
In-Reply-To: <20200920171703.3692328-1-andrew@lunn.ch>

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(+)

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


  reply	other threads:[~2020-09-20 17:17 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-20 17:16 [PATCH net-next 0/5] PHY subsystem kernel doc Andrew Lunn
2020-09-20 17:16 ` Andrew Lunn [this message]
2020-09-20 21:07   ` [PATCH net-next 1/5] net: netdevice.h: Document proto_down_reason Florian Fainelli
2020-09-20 17:17 ` [PATCH net-next 2/5] net: netdevice.h: Document xdp_state Andrew Lunn
2020-09-20 17:17 ` [PATCH net-next 3/5] net: phy: Fixup kernel doc Andrew Lunn
2020-09-20 21:07   ` Florian Fainelli
2020-09-20 17:17 ` [PATCH net-next 4/5] net: phy: Document core PHY structures Andrew Lunn
2020-09-20 21:29   ` Florian Fainelli
2020-09-20 17:17 ` [PATCH net-next 5/5] net: mdio: Add kerneldoc for main data structures and some functions Andrew Lunn
2020-09-20 21:11   ` Florian Fainelli
2020-09-20 17:44 ` [PATCH net-next 0/5] PHY subsystem kernel doc Randy Dunlap
2020-09-21 21:45 ` David Miller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200920171703.3692328-2-andrew@lunn.ch \
    --to=andrew@lunn.ch \
    --cc=davem@davemloft.net \
    --cc=f.fainelli@gmail.com \
    --cc=hkallweit1@gmail.com \
    --cc=netdev@vger.kernel.org \
    --cc=roopa@cumulusnetworks.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).