Commit a1fa83bd authored by Randy Dunlap's avatar Randy Dunlap Committed by David S. Miller
Browse files

netdevice.h: fix all kernel-doc and Sphinx warnings 



Eliminate all kernel-doc and Sphinx warnings in
<linux/netdevice.h>.  Fixes these warnings:

../include/linux/netdevice.h:2100: warning: Function parameter or member 'gso_partial_features' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'l3mdev_ops' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'xfrmdev_ops' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'tlsdev_ops' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'name_assign_type' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'ieee802154_ptr' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'mpls_ptr' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'xdp_prog' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'gro_flush_timeout' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'xdp_bulkq' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'xps_cpus_map' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'xps_rxqs_map' not described in 'net_device'
../include/linux/netdevice.h:2100: warning: Function parameter or member 'qdisc_hash' not described in 'net_device'
../include/linux/netdevice.h:3552: WARNING: Inline emphasis start-string without end-string.
../include/linux/netdevice.h:3552: WARNING: Inline emphasis start-string without end-string.

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 3ea89fa7

include/linux/netdevice.h

+15 −1
Original line number Diff line number Diff line
@@ -1616,6 +1616,7 @@ enum netdev_priv_flags { 
 *				and drivers will need to set them appropriately.

 *

 *	@mpls_features:	Mask of features inheritable by MPLS

 *	@gso_partial_features: value(s) from NETIF_F_GSO\*

 *

 *	@ifindex:	interface index

 *	@group:		The group the device belongs to
@@ -1640,8 +1641,11 @@ enum netdev_priv_flags { 
 *	@netdev_ops:	Includes several pointers to callbacks,

 *			if one wants to override the ndo_*() functions

 *	@ethtool_ops:	Management operations

 *	@l3mdev_ops:	Layer 3 master device operations

 *	@ndisc_ops:	Includes callbacks for different IPv6 neighbour

 *			discovery handling. Necessary for e.g. 6LoWPAN.

 *	@xfrmdev_ops:	Transformation offload operations

 *	@tlsdev_ops:	Transport Layer Security offload operations

 *	@header_ops:	Includes callbacks for creating,parsing,caching,etc

 *			of Layer 2 headers.

 *
@@ -1680,6 +1684,7 @@ enum netdev_priv_flags { 
 * 	@dev_port:		Used to differentiate devices that share

 * 				the same function

 *	@addr_list_lock:	XXX: need comments on this one

 *	@name_assign_type:	network interface name assignment type

 *	@uc_promisc:		Counter that indicates promiscuous mode

 *				has been enabled due to the need to listen to

 *				additional unicast addresses in a device that
@@ -1702,6 +1707,9 @@ enum netdev_priv_flags { 
 *	@ip6_ptr:	IPv6 specific data

 *	@ax25_ptr:	AX.25 specific data

 *	@ieee80211_ptr:	IEEE 802.11 specific data, assign before registering

 *	@ieee802154_ptr: IEEE 802.15.4 low-rate Wireless Personal Area Network

 *			 device struct

 *	@mpls_ptr:	mpls_dev struct pointer

 *

 *	@dev_addr:	Hw address (before bcast,

 *			because most packets are unicast)
@@ -1710,6 +1718,8 @@ enum netdev_priv_flags { 
 *	@num_rx_queues:		Number of RX queues

 *				allocated at register_netdev() time

 *	@real_num_rx_queues: 	Number of RX queues currently active in device

 *	@xdp_prog:		XDP sockets filter program pointer

 *	@gro_flush_timeout:	timeout for GRO layer in NAPI

 *

 *	@rx_handler:		handler for received packets

 *	@rx_handler_data: 	XXX: need comments on this one
@@ -1731,10 +1741,14 @@ enum netdev_priv_flags { 
 *	@qdisc:			Root qdisc from userspace point of view

 *	@tx_queue_len:		Max frames per queue allowed

 *	@tx_global_lock: 	XXX: need comments on this one

 *	@xdp_bulkq:		XDP device bulk queue

 *	@xps_cpus_map:		all CPUs map for XPS device

 *	@xps_rxqs_map:		all RXQs map for XPS device

 *

 *	@xps_maps:	XXX: need comments on this one

 *	@miniq_egress:		clsact qdisc specific data for

 *				egress processing

 *	@qdisc_hash:		qdisc hash table

 *	@watchdog_timeo:	Represents the timeout that is used by

 *				the watchdog (see dev_watchdog())

 *	@watchdog_timer:	List of timers
@@ -3548,7 +3562,7 @@ static inline unsigned int netif_attrmask_next(int n, const unsigned long *srcp, 
}



/**

 *	netif_attrmask_next_and - get the next CPU/Rx queue in *src1p & *src2p

 *	netif_attrmask_next_and - get the next CPU/Rx queue in \*src1p & \*src2p

 *	@n: CPU/Rx queue index

 *	@src1p: the first CPUs/Rx queues mask pointer

 *	@src2p: the second CPUs/Rx queues mask pointer

CRA Git | Maintained and supported by SUSTech CRA and CCSE