2023-06-27 07:03:12

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] docs: add more driver-model infrastructure interfaces

Add bus, class, and device data structures and enum constants to the
Driver-Model Structures section and add function interfaces to the
Device Drivers Base section of the Device drivers infrastructure chapter.

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
Cc: Greg Kroah-Hartman <[email protected]>
Cc: "Rafael J. Wysocki" <[email protected]>
---
Documentation/driver-api/infrastructure.rst | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)

diff -- a/Documentation/driver-api/infrastructure.rst b/Documentation/driver-api/infrastructure.rst
--- a/Documentation/driver-api/infrastructure.rst
+++ b/Documentation/driver-api/infrastructure.rst
@@ -8,12 +8,24 @@ The Basic Device Driver-Model Structures
:internal:
:no-identifiers: device_link_state

+.. kernel-doc:: include/linux/device/bus.h
+ :identifiers: bus_type bus_notifier_event
+
+.. kernel-doc:: include/linux/device/class.h
+ :identifiers: class
+
+.. kernel-doc:: include/linux/device/driver.h
+ :identifiers: probe_type device_driver
+
Device Drivers Base
-------------------

.. kernel-doc:: drivers/base/init.c
:internal:

+.. kernel-doc:: include/linux/device/driver.h
+ :no-identifiers: probe_type device_driver
+
.. kernel-doc:: drivers/base/driver.c
:export:

@@ -23,6 +35,9 @@ Device Drivers Base
.. kernel-doc:: drivers/base/syscore.c
:export:

+.. kernel-doc:: include/linux/device/class.h
+ :no-identifiers: class
+
.. kernel-doc:: drivers/base/class.c
:export:

@@ -41,6 +56,9 @@ Device Drivers Base
.. kernel-doc:: drivers/base/platform.c
:export:

+.. kernel-doc:: include/linux/device/bus.h
+ :no-identifiers: bus_type bus_notifier_event
+
.. kernel-doc:: drivers/base/bus.c
:export:



2023-07-14 20:02:41

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] docs: add more driver-model infrastructure interfaces

Randy Dunlap <[email protected]> writes:

> Add bus, class, and device data structures and enum constants to the
> Driver-Model Structures section and add function interfaces to the
> Device Drivers Base section of the Device drivers infrastructure chapter.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: "Rafael J. Wysocki" <[email protected]>
> ---
> Documentation/driver-api/infrastructure.rst | 18 ++++++++++++++++++
> 1 file changed, 18 insertions(+)

Applied, thanks.

jon