Commit 11a96703 authored by Wedson Almeida Filho's avatar Wedson Almeida Filho Committed by Greg Kroah-Hartman
Browse files

driver core: update comments in device_rename() 



Document that some subsystems are still going to use device_rename for
the time being, so it is not a good idea to assume it's not used. Also
remove mentions of a plan to stop renaming net devices.

Signed-off-by: default avatarWedson Almeida Filho <walmeida@microsoft.com>
Link: https://lore.kernel.org/r/20230406045435.19452-1-wedsonaf@gmail.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent e2f06aa8

drivers/base/core.c

+6 −10
Original line number Diff line number Diff line
@@ -4416,9 +4416,12 @@ EXPORT_SYMBOL_GPL(device_destroy); 
 * on the same device to ensure that new_name is valid and

 * won't conflict with other devices.

 *

 * Note: Don't call this function.  Currently, the networking layer calls this

 * function, but that will change.  The following text from Kay Sievers offers

 * some insight:

 * Note: given that some subsystems (networking and infiniband) use this

 * function, with no immediate plans for this to change, we cannot assume or

 * require that this function not be called at all.

 *

 * However, if you're writing new code, do not call this function. The following

 * text from Kay Sievers offers some insight:

 *

 * Renaming devices is racy at many levels, symlinks and other stuff are not

 * replaced atomically, and you get a "move" uevent, but it's not easy to
@@ -4432,13 +4435,6 @@ EXPORT_SYMBOL_GPL(device_destroy); 
 * kernel device renaming. Besides that, it's not even implemented now for

 * other things than (driver-core wise very simple) network devices.

 *

 * We are currently about to change network renaming in udev to completely

 * disallow renaming of devices in the same namespace as the kernel uses,

 * because we can't solve the problems properly, that arise with swapping names

 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only

 * be allowed to some other name than eth[0-9]*, for the aforementioned

 * reasons.

 *

 * Make up a "real" name in the driver before you register anything, or add

 * some other attributes for userspace to find the device, or use udev to add

 * symlinks -- but never rename kernel devices later, it's a complete mess. We