Re: [PATCH v3] Expose the bus kernel docs to the build docs.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Matthew,

I hate to bother you, but how do I know if this patch is acceptable or not. I am not sure how this is tracked.

Thanks,
wt

On 3/8/21 11:14 AM, Wren Turkal wrote:
Before, the bus type related APIs that were defined in the
include/linux/device/bus.h were not referenced anywhere in the docs, so
I linked it to the bus types api documentation.

Signed-off-by: Wren Turkal <wt@xxxxxxxxxxxxxxxx>
---
  Documentation/driver-api/driver-model/bus.rst | 8 ++++++++
  Documentation/driver-api/infrastructure.rst   | 3 +--
  2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/Documentation/driver-api/driver-model/bus.rst b/Documentation/driver-api/driver-model/bus.rst
index 016b15a6e8ea..c53b01e95fd9 100644
--- a/Documentation/driver-api/driver-model/bus.rst
+++ b/Documentation/driver-api/driver-model/bus.rst
@@ -1,3 +1,5 @@
+.. _bus_types:
+
  =========
  Bus Types
  =========
@@ -144,3 +146,9 @@ sysfs directory using::
int bus_create_file(struct bus_type *, struct bus_attribute *);
  	void bus_remove_file(struct bus_type *, struct bus_attribute *);
+
+Functions and Structures
+========================
+
+.. kernel-doc:: include/linux/device/bus.h
+.. kernel-doc:: drivers/base/bus.c
diff --git a/Documentation/driver-api/infrastructure.rst b/Documentation/driver-api/infrastructure.rst
index 683bd460e222..eb2a2c9e3c0c 100644
--- a/Documentation/driver-api/infrastructure.rst
+++ b/Documentation/driver-api/infrastructure.rst
@@ -41,8 +41,7 @@ Device Drivers Base
  .. kernel-doc:: drivers/base/platform.c
     :export:
-.. kernel-doc:: drivers/base/bus.c
-   :export:
+:ref:`bus_types`
Device Drivers DMA Management
  -----------------------------


--
You're more amazing than you think! ymatyt.com



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux