]> git.ipfire.org Git - thirdparty/linux.git/commit
driver-core: improve driver binding documentation
authorDanilo Krummrich <dakr@kernel.org>
Thu, 15 Jan 2026 21:56:57 +0000 (22:56 +0100)
committerJonathan Corbet <corbet@lwn.net>
Fri, 16 Jan 2026 18:14:36 +0000 (11:14 -0700)
commit07265c326b40be866826d759d2aec40cfcb59ac4
tree0ea0a8d41705b7dc86a075c53ffd22a95c49354c
parent8913632998fcda1793d04fd4ae2327b4bee9b106
driver-core: improve driver binding documentation

The driver binding documentation (still) mentions that "When a driver is
attached to a device, the device is inserted into the driver's list of
devices.".

While it is true that the driver-core keeps track of all the devices
that are attached to a driver, this is purely for internal purposes
(i.e. it is an implementation detail) and has no relevance for user
facing documentation.

In fact, it is even misleading, since it could be read as if it were
valid for driver implementations to keep track of all the devices bound
to it.

Instead, drivers operate on a per-device basis, with a separate
per-device instance created when the driver is bound to a device.

Hence, remove the mention of a driver's list of devices and instead add
some documentation of the relationship between drivers and devices.

Signed-off-by: Danilo Krummrich <dakr@kernel.org>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260115215718.6405-1-dakr@kernel.org>
Documentation/driver-api/driver-model/binding.rst