Commit c4ea43c5 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

net core: fix kernel-doc for new function parameters 



Fix networking code kernel-doc for newly added parameters.

Warning(linux-2.6.23-git2//net/core/sock.c:879): No description found for parameter 'net'
Warning(linux-2.6.23-git2//net/core/dev.c:570): No description found for parameter 'net'
Warning(linux-2.6.23-git2//net/core/dev.c:594): No description found for parameter 'net'
Warning(linux-2.6.23-git2//net/core/dev.c:617): No description found for parameter 'net'
Warning(linux-2.6.23-git2//net/core/dev.c:641): No description found for parameter 'net'
Warning(linux-2.6.23-git2//net/core/dev.c:667): No description found for parameter 'net'
Warning(linux-2.6.23-git2//net/core/dev.c:722): No description found for parameter 'net'
Warning(linux-2.6.23-git2//net/core/dev.c:959): No description found for parameter 'net'
Warning(linux-2.6.23-git2//net/core/dev.c:1195): No description found for parameter 'dev'
Warning(linux-2.6.23-git2//net/core/dev.c:2105): No description found for parameter 'n'
Warning(linux-2.6.23-git2//net/core/dev.c:3272): No description found for parameter 'net'
Warning(linux-2.6.23-git2//net/core/dev.c:3445): No description found for parameter 'net'
Warning(linux-2.6.23-git2//include/linux/netdevice.h:1301): No description found for parameter 'cpu'

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 22e67bb6

include/linux/netdevice.h

+1 −0
Original line number Diff line number Diff line
@@ -1294,6 +1294,7 @@ static inline void netif_rx_complete(struct net_device *dev, 
/**

 *	netif_tx_lock - grab network device transmit lock

 *	@dev: network device

 *	@cpu: cpu number of lock owner

 *

 * Get network device transmit lock

 */

net/core/dev.c

+11 −2
Original line number Diff line number Diff line
@@ -557,6 +557,7 @@ __setup("netdev=", netdev_boot_setup); 


/**

 *	__dev_get_by_name	- find a device by its name

 *	@net: the applicable net namespace

 *	@name: name to find

 *

 *	Find an interface by name. Must be called under RTNL semaphore
@@ -581,6 +582,7 @@ struct net_device *__dev_get_by_name(struct net *net, const char *name) 


/**

 *	dev_get_by_name		- find a device by its name

 *	@net: the applicable net namespace

 *	@name: name to find

 *

 *	Find an interface by name. This can be called from any
@@ -604,6 +606,7 @@ struct net_device *dev_get_by_name(struct net *net, const char *name) 


/**

 *	__dev_get_by_index - find a device by its ifindex

 *	@net: the applicable net namespace

 *	@ifindex: index of device

 *

 *	Search for an interface by index. Returns %NULL if the device
@@ -629,6 +632,7 @@ struct net_device *__dev_get_by_index(struct net *net, int ifindex) 


/**

 *	dev_get_by_index - find a device by its ifindex

 *	@net: the applicable net namespace

 *	@ifindex: index of device

 *

 *	Search for an interface by index. Returns NULL if the device
@@ -651,6 +655,7 @@ struct net_device *dev_get_by_index(struct net *net, int ifindex) 


/**

 *	dev_getbyhwaddr - find a device by its hardware address

 *	@net: the applicable net namespace

 *	@type: media type of device

 *	@ha: hardware address

 *
@@ -709,6 +714,7 @@ EXPORT_SYMBOL(dev_getfirstbyhwtype); 


/**

 *	dev_get_by_flags - find any device with given flags

 *	@net: the applicable net namespace

 *	@if_flags: IFF_* values

 *	@mask: bitmask of bits in if_flags to check

 *
@@ -948,6 +954,7 @@ void netdev_state_change(struct net_device *dev) 


/**

 *	dev_load 	- load a network module

 *	@net: the applicable net namespace

 *	@name: name of interface

 *

 *	If a network interface is not present and the process has suitable
@@ -1185,7 +1192,7 @@ int unregister_netdevice_notifier(struct notifier_block *nb) 
/**

 *	call_netdevice_notifiers - call all network notifier blocks

 *      @val: value passed unmodified to notifier function

 *      @v:   pointer passed unmodified to notifier function

 *      @dev: net_device pointer passed unmodified to notifier function

 *

 *	Call all network notifier blocks.  Parameters and return value

 *	are as for raw_notifier_call_chain().
@@ -2097,7 +2104,7 @@ static int process_backlog(struct napi_struct *napi, int quota) 


/**

 * __napi_schedule - schedule for receive

 * @napi: entry to schedule

 * @n: entry to schedule

 *

 * The entry's receive function will be scheduled to run

 */
@@ -3259,6 +3266,7 @@ static int dev_ifsioc(struct net *net, struct ifreq *ifr, unsigned int cmd) 


/**

 *	dev_ioctl	-	network device ioctl

 *	@net: the applicable net namespace

 *	@cmd: command to issue

 *	@arg: pointer to a struct ifreq in user space

 *
@@ -3436,6 +3444,7 @@ int dev_ioctl(struct net *net, unsigned int cmd, void __user *arg) 


/**

 *	dev_new_index	-	allocate an ifindex

 *	@net: the applicable net namespace

 *

 *	Returns a suitable unique value for a new device interface

 *	number.  The caller must hold the rtnl semaphore or the

net/core/sock.c

+1 −0
Original line number Diff line number Diff line
@@ -869,6 +869,7 @@ static inline void sock_lock_init(struct sock *sk) 


/**

 *	sk_alloc - All socket objects are allocated here

 *	@net: the applicable net namespace

 *	@family: protocol family

 *	@priority: for allocation (%GFP_KERNEL, %GFP_ATOMIC, etc)

 *	@prot: struct proto associated with this new sock instance