[PATCH net-next] net: update the register_netdevice() kdoc

[PATCH net-next] net: update the register_netdevice() kdoc

[Jakub Kicinski]

The BUGS section looks quite dated, the registration
is under rtnl lock. Remove some obvious information
while at it.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 net/core/dev.c | 20 ++++++--------------
 1 file changed, 6 insertions(+), 14 deletions(-)

diff --git a/net/core/dev.c b/net/core/dev.c
index 91b7e7784da9..a601da3b4a7c 100644
--- a/net/core/dev.c
+++ b/net/core/dev.c
@@ -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;
-- 
2.34.3

Re: [PATCH net-next] net: update the register_netdevice() kdoc

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (master)
by Jakub Kicinski <kuba@kernel.org>:

On Wed, 11 May 2022 12:07:20 -0700 you wrote:
> The BUGS section looks quite dated, the registration
> is under rtnl lock. Remove some obvious information
> while at it.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
>  net/core/dev.c | 20 ++++++--------------
>  1 file changed, 6 insertions(+), 14 deletions(-)

Here is the summary with links:
  - [net-next] net: update the register_netdevice() kdoc
    https://git.kernel.org/netdev/net-next/c/fa926bb3e491

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html