diff mbox series

[net] netdevice.h: fix proto_down_reason kernel-doc warning

Message ID 7275c711-b313-b78c-bea5-e836f323b0ef@infradead.org
State New
Headers show
Series [net] netdevice.h: fix proto_down_reason kernel-doc warning | expand

Commit Message

Randy Dunlap Sept. 7, 2020, 3:31 a.m. UTC 
From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warning in <linux/netdevice.h>:

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

Fixes: 829eb208e80d ("rtnetlink: add support for protodown reason")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Roopa Prabhu <roopa@cumulusnetworks.com>
---
 include/linux/netdevice.h |    1 +
 1 file changed, 1 insertion(+)

Comments

Roopa Prabhu Sept. 7, 2020, 6:02 a.m. UTC | #1 
On 9/6/20 8:31 PM, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix kernel-doc warning in <linux/netdevice.h>:
>
> ../include/linux/netdevice.h:2158: warning: Function parameter or member 'proto_down_reason' not described in 'net_device'
>
> Fixes: 829eb208e80d ("rtnetlink: add support for protodown reason")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Roopa Prabhu <roopa@cumulusnetworks.com>
> ---

Acked-by: Roopa Prabhu <roopa@cumulusnetworks.com>

Thanks Randy
Jakub Kicinski Sept. 7, 2020, 7:49 p.m. UTC | #2 
On Sun, 6 Sep 2020 20:31:16 -0700 Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warning in <linux/netdevice.h>:
> 
> ../include/linux/netdevice.h:2158: warning: Function parameter or member 'proto_down_reason' not described in 'net_device'
> 
> Fixes: 829eb208e80d ("rtnetlink: add support for protodown reason")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Roopa Prabhu <roopa@cumulusnetworks.com>

Applied, but I had to fix a checkpatch warning about a space before a
tab..
Randy Dunlap Sept. 7, 2020, 7:57 p.m. UTC | #3 
On 9/7/20 12:49 PM, Jakub Kicinski wrote:
> On Sun, 6 Sep 2020 20:31:16 -0700 Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@infradead.org>
>>
>> Fix kernel-doc warning in <linux/netdevice.h>:
>>
>> ../include/linux/netdevice.h:2158: warning: Function parameter or member 'proto_down_reason' not described in 'net_device'
>>
>> Fixes: 829eb208e80d ("rtnetlink: add support for protodown reason")
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Roopa Prabhu <roopa@cumulusnetworks.com>
> 
> Applied, but I had to fix a checkpatch warning about a space before a
> tab..

Ohhh, thanks.
I blame that on (g)vim providing some automatic indentation that I didn't want.
diff mbox series

Patch

--- lnx-59-rc4.orig/include/linux/netdevice.h
+++ lnx-59-rc4/include/linux/netdevice.h
@@ -1784,6 +1784,7 @@  enum netdev_priv_flags {
  *				the watchdog (see dev_watchdog())
  *	@watchdog_timer:	List of timers
  *
+ * 	@proto_down_reason:	reason a netdev interface is held down
  *	@pcpu_refcnt:		Number of references to this device
  *	@todo_list:		Delayed register/unregister
  *	@link_watch_list:	XXX: need comments on this one