Docs: driver-api/basics: add kobject_event interfaces

[PATCH] Docs: driver-api/basics: add kobject_event interfaces

Posted by Randy Dunlap 9 months ago

Add the kernel-doc comments from lib/kobject_uevent.c to the
"Kernel objects manipulation" section of driver API Basics.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Danilo Krummrich <dakr@kernel.org>
---
 Documentation/driver-api/basics.rst |    3 +++
 1 file changed, 3 insertions(+)

--- linux-next-20250508.orig/Documentation/driver-api/basics.rst
+++ linux-next-20250508/Documentation/driver-api/basics.rst
@@ -108,6 +108,9 @@ Kernel objects manipulation
 .. kernel-doc:: lib/kobject.c
    :export:
 
+.. kernel-doc:: lib/kobject_uevent.c
+   :export:
+
 Kernel utility functions
 ------------------------

Re: [PATCH] Docs: driver-api/basics: add kobject_event interfaces

Posted by Jonathan Corbet 8 months, 3 weeks ago

Randy Dunlap <rdunlap@infradead.org> writes:

> Add the kernel-doc comments from lib/kobject_uevent.c to the
> "Kernel objects manipulation" section of driver API Basics.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: "Rafael J. Wysocki" <rafael@kernel.org>
> Cc: Danilo Krummrich <dakr@kernel.org>
> ---
>  Documentation/driver-api/basics.rst |    3 +++
>  1 file changed, 3 insertions(+)
>
> --- linux-next-20250508.orig/Documentation/driver-api/basics.rst
> +++ linux-next-20250508/Documentation/driver-api/basics.rst
> @@ -108,6 +108,9 @@ Kernel objects manipulation
>  .. kernel-doc:: lib/kobject.c
>     :export:
>  
> +.. kernel-doc:: lib/kobject_uevent.c
> +   :export:

Applied, thanks.

jon