net: update the register_netdevice() kdoc
authorJakub Kicinski <kuba@kernel.org>
Wed, 11 May 2022 19:07:20 +0000 (12:07 -0700)
committerJakub Kicinski <kuba@kernel.org>
Thu, 12 May 2022 23:21:11 +0000 (16:21 -0700)
The BUGS section looks quite dated, the registration
is under rtnl lock. Remove some obvious information
while at it.

Link: https://lore.kernel.org/r/20220511190720.1401356-1-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
net/core/dev.c

index 91b7e77..a601da3 100644 (file)
@@ -9927,22 +9927,14 @@ void netif_tx_stop_all_queues(struct net_device *dev)
 EXPORT_SYMBOL(netif_tx_stop_all_queues);
 
 /**
- *     register_netdevice      - register a network device
- *     @dev: device to register
- *
- *     Take a completed network device structure and add it to the kernel
- *     interfaces. A %NETDEV_REGISTER message is sent to the netdev notifier
- *     chain. 0 is returned on success. A negative errno code is returned
- *     on a failure to set up the device, or if the name is a duplicate.
+ * register_netdevice() - register a network device
+ * @dev: device to register
  *
- *     Callers must hold the rtnl semaphore. You may want
- *     register_netdev() instead of this.
- *
- *     BUGS:
- *     The locking appears insufficient to guarantee two parallel registers
- *     will not get the same name.
+ * Take a prepared network device structure and make it externally accessible.
+ * A %NETDEV_REGISTER message is sent to the netdev notifier chain.
+ * Callers must hold the rtnl lock - you may want register_netdev()
+ * instead of this.
  */
-
 int register_netdevice(struct net_device *dev)
 {
        int ret;