diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2007-10-13 00:17:49 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-10-13 12:52:26 -0400 |
commit | c4ea43c552ecc9ccc564e11e70d397dbdf09484b (patch) | |
tree | 98ad3cd268d3e9c3ac466ef7226a83a752aa23dd | |
parent | 22e67bb6c1554dc804ee44569f43b2e9c8e591e7 (diff) |
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: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
-rw-r--r-- | include/linux/netdevice.h | 1 | ||||
-rw-r--r-- | net/core/dev.c | 13 | ||||
-rw-r--r-- | net/core/sock.c | 1 |
3 files changed, 13 insertions, 2 deletions
diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h index 5a11f889e56a..39dd83b183a9 100644 --- a/include/linux/netdevice.h +++ b/include/linux/netdevice.h | |||
@@ -1294,6 +1294,7 @@ static inline void netif_rx_complete(struct net_device *dev, | |||
1294 | /** | 1294 | /** |
1295 | * netif_tx_lock - grab network device transmit lock | 1295 | * netif_tx_lock - grab network device transmit lock |
1296 | * @dev: network device | 1296 | * @dev: network device |
1297 | * @cpu: cpu number of lock owner | ||
1297 | * | 1298 | * |
1298 | * Get network device transmit lock | 1299 | * Get network device transmit lock |
1299 | */ | 1300 | */ |
diff --git a/net/core/dev.c b/net/core/dev.c index 1e169a541ce7..99b7bda37d10 100644 --- a/net/core/dev.c +++ b/net/core/dev.c | |||
@@ -557,6 +557,7 @@ __setup("netdev=", netdev_boot_setup); | |||
557 | 557 | ||
558 | /** | 558 | /** |
559 | * __dev_get_by_name - find a device by its name | 559 | * __dev_get_by_name - find a device by its name |
560 | * @net: the applicable net namespace | ||
560 | * @name: name to find | 561 | * @name: name to find |
561 | * | 562 | * |
562 | * Find an interface by name. Must be called under RTNL semaphore | 563 | * 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) | |||
581 | 582 | ||
582 | /** | 583 | /** |
583 | * dev_get_by_name - find a device by its name | 584 | * dev_get_by_name - find a device by its name |
585 | * @net: the applicable net namespace | ||
584 | * @name: name to find | 586 | * @name: name to find |
585 | * | 587 | * |
586 | * Find an interface by name. This can be called from any | 588 | * 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) | |||
604 | 606 | ||
605 | /** | 607 | /** |
606 | * __dev_get_by_index - find a device by its ifindex | 608 | * __dev_get_by_index - find a device by its ifindex |
609 | * @net: the applicable net namespace | ||
607 | * @ifindex: index of device | 610 | * @ifindex: index of device |
608 | * | 611 | * |
609 | * Search for an interface by index. Returns %NULL if the device | 612 | * 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) | |||
629 | 632 | ||
630 | /** | 633 | /** |
631 | * dev_get_by_index - find a device by its ifindex | 634 | * dev_get_by_index - find a device by its ifindex |
635 | * @net: the applicable net namespace | ||
632 | * @ifindex: index of device | 636 | * @ifindex: index of device |
633 | * | 637 | * |
634 | * Search for an interface by index. Returns NULL if the device | 638 | * 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) | |||
651 | 655 | ||
652 | /** | 656 | /** |
653 | * dev_getbyhwaddr - find a device by its hardware address | 657 | * dev_getbyhwaddr - find a device by its hardware address |
658 | * @net: the applicable net namespace | ||
654 | * @type: media type of device | 659 | * @type: media type of device |
655 | * @ha: hardware address | 660 | * @ha: hardware address |
656 | * | 661 | * |
@@ -709,6 +714,7 @@ EXPORT_SYMBOL(dev_getfirstbyhwtype); | |||
709 | 714 | ||
710 | /** | 715 | /** |
711 | * dev_get_by_flags - find any device with given flags | 716 | * dev_get_by_flags - find any device with given flags |
717 | * @net: the applicable net namespace | ||
712 | * @if_flags: IFF_* values | 718 | * @if_flags: IFF_* values |
713 | * @mask: bitmask of bits in if_flags to check | 719 | * @mask: bitmask of bits in if_flags to check |
714 | * | 720 | * |
@@ -948,6 +954,7 @@ void netdev_state_change(struct net_device *dev) | |||
948 | 954 | ||
949 | /** | 955 | /** |
950 | * dev_load - load a network module | 956 | * dev_load - load a network module |
957 | * @net: the applicable net namespace | ||
951 | * @name: name of interface | 958 | * @name: name of interface |
952 | * | 959 | * |
953 | * If a network interface is not present and the process has suitable | 960 | * If a network interface is not present and the process has suitable |
@@ -1185,7 +1192,7 @@ int unregister_netdevice_notifier(struct notifier_block *nb) | |||
1185 | /** | 1192 | /** |
1186 | * call_netdevice_notifiers - call all network notifier blocks | 1193 | * call_netdevice_notifiers - call all network notifier blocks |
1187 | * @val: value passed unmodified to notifier function | 1194 | * @val: value passed unmodified to notifier function |
1188 | * @v: pointer passed unmodified to notifier function | 1195 | * @dev: net_device pointer passed unmodified to notifier function |
1189 | * | 1196 | * |
1190 | * Call all network notifier blocks. Parameters and return value | 1197 | * Call all network notifier blocks. Parameters and return value |
1191 | * are as for raw_notifier_call_chain(). | 1198 | * are as for raw_notifier_call_chain(). |
@@ -2097,7 +2104,7 @@ static int process_backlog(struct napi_struct *napi, int quota) | |||
2097 | 2104 | ||
2098 | /** | 2105 | /** |
2099 | * __napi_schedule - schedule for receive | 2106 | * __napi_schedule - schedule for receive |
2100 | * @napi: entry to schedule | 2107 | * @n: entry to schedule |
2101 | * | 2108 | * |
2102 | * The entry's receive function will be scheduled to run | 2109 | * The entry's receive function will be scheduled to run |
2103 | */ | 2110 | */ |
@@ -3259,6 +3266,7 @@ static int dev_ifsioc(struct net *net, struct ifreq *ifr, unsigned int cmd) | |||
3259 | 3266 | ||
3260 | /** | 3267 | /** |
3261 | * dev_ioctl - network device ioctl | 3268 | * dev_ioctl - network device ioctl |
3269 | * @net: the applicable net namespace | ||
3262 | * @cmd: command to issue | 3270 | * @cmd: command to issue |
3263 | * @arg: pointer to a struct ifreq in user space | 3271 | * @arg: pointer to a struct ifreq in user space |
3264 | * | 3272 | * |
@@ -3436,6 +3444,7 @@ int dev_ioctl(struct net *net, unsigned int cmd, void __user *arg) | |||
3436 | 3444 | ||
3437 | /** | 3445 | /** |
3438 | * dev_new_index - allocate an ifindex | 3446 | * dev_new_index - allocate an ifindex |
3447 | * @net: the applicable net namespace | ||
3439 | * | 3448 | * |
3440 | * Returns a suitable unique value for a new device interface | 3449 | * Returns a suitable unique value for a new device interface |
3441 | * number. The caller must hold the rtnl semaphore or the | 3450 | * number. The caller must hold the rtnl semaphore or the |
diff --git a/net/core/sock.c b/net/core/sock.c index 4ed9b507c1e7..d45ecdccc6a1 100644 --- a/net/core/sock.c +++ b/net/core/sock.c | |||
@@ -869,6 +869,7 @@ static inline void sock_lock_init(struct sock *sk) | |||
869 | 869 | ||
870 | /** | 870 | /** |
871 | * sk_alloc - All socket objects are allocated here | 871 | * sk_alloc - All socket objects are allocated here |
872 | * @net: the applicable net namespace | ||
872 | * @family: protocol family | 873 | * @family: protocol family |
873 | * @priority: for allocation (%GFP_KERNEL, %GFP_ATOMIC, etc) | 874 | * @priority: for allocation (%GFP_KERNEL, %GFP_ATOMIC, etc) |
874 | * @prot: struct proto associated with this new sock instance | 875 | * @prot: struct proto associated with this new sock instance |