public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Kuan-Wei Chiu <visitorckw@gmail.com>
To: djakov@kernel.org, corbet@lwn.net, skhan@linuxfoundation.org
Cc: marscheng@google.com, wllee@google.com, aarontian@google.com,
	jserv@ccns.ncku.edu.tw, linux-doc@vger.kernel.org,
	linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
	Kuan-Wei Chiu <visitorckw@gmail.com>
Subject: [PATCH 2/2] docs: interconnect: Document consumer APIs and drop outdated text
Date: Thu, 12 Mar 2026 17:53:41 +0000	[thread overview]
Message-ID: <20260312175341.2944154-3-visitorckw@gmail.com> (raw)
In-Reply-To: <20260312175341.2944154-1-visitorckw@gmail.com>

The documentation currently states that consumer interfaces are not
documented, which is no longer true.

Remove the outdated claim and include the existing kernel-doc from
drivers/interconnect/core.c (filtered for consumer APIs) and
drivers/interconnect/bulk.c.

Signed-off-by: Kuan-Wei Chiu <visitorckw@gmail.com>
---
 Documentation/driver-api/interconnect.rst | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/driver-api/interconnect.rst b/Documentation/driver-api/interconnect.rst
index cf7a83f8c953..cebb77b49d8d 100644
--- a/Documentation/driver-api/interconnect.rst
+++ b/Documentation/driver-api/interconnect.rst
@@ -95,8 +95,14 @@ Interconnect consumers
 
 Interconnect consumers are the clients which use the interconnect APIs to
 get paths between endpoints and set their bandwidth/latency/QoS requirements
-for these interconnect paths.  These interfaces are not currently
-documented.
+for these interconnect paths.
+
+.. kernel-doc:: drivers/interconnect/core.c
+   :functions: devm_of_icc_get of_icc_get_by_index of_icc_get icc_get
+               icc_put icc_enable icc_disable icc_set_bw icc_set_tag
+               icc_get_name
+
+.. kernel-doc:: drivers/interconnect/bulk.c
 
 Interconnect debugfs interfaces
 -------------------------------
-- 
2.53.0.851.ga537e3e6e9-goog


  parent reply	other threads:[~2026-03-12 17:54 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-12 17:53 [PATCH 0/2] docs: interconnect: Improve API documentation coverage Kuan-Wei Chiu
2026-03-12 17:53 ` [PATCH 1/2] docs: interconnect: Add provider APIs to documentation Kuan-Wei Chiu
2026-03-12 17:53 ` Kuan-Wei Chiu [this message]
2026-03-17 14:53 ` [PATCH 0/2] docs: interconnect: Improve API documentation coverage Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260312175341.2944154-3-visitorckw@gmail.com \
    --to=visitorckw@gmail.com \
    --cc=aarontian@google.com \
    --cc=corbet@lwn.net \
    --cc=djakov@kernel.org \
    --cc=jserv@ccns.ncku.edu.tw \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=marscheng@google.com \
    --cc=skhan@linuxfoundation.org \
    --cc=wllee@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox