From: Jonathan Corbet <corbet@lwn.net>
To: Kuan-Wei Chiu <visitorckw@gmail.com>,
djakov@kernel.org, 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: Re: [PATCH 0/2] docs: interconnect: Improve API documentation coverage
Date: Tue, 17 Mar 2026 08:53:18 -0600 [thread overview]
Message-ID: <87se9ycxsx.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20260312175341.2944154-1-visitorckw@gmail.com>
Kuan-Wei Chiu <visitorckw@gmail.com> writes:
> Improve the generic interconnect subsystem documentation by including
> the existing kernel-doc comments from the source files.
>
> Currently, the documentation only includes the provider data structures
> from the header file and incorrectly states that consumer APIs are
> undocumented.
>
> Since drivers/interconnect/core.c contains a mix of both provider and
> consumer APIs, this series uses the kernel-doc :functions: directive to
> properly separate and document them in their respective sections.
>
> Kuan-Wei Chiu (2):
> docs: interconnect: Add provider APIs to documentation
> docs: interconnect: Document consumer APIs and drop outdated text
>
> Documentation/driver-api/interconnect.rst | 16 ++++++++++++++--
> 1 file changed, 14 insertions(+), 2 deletions(-)
Series applied, thanks.
jon
prev parent reply other threads:[~2026-03-17 14:53 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 ` [PATCH 2/2] docs: interconnect: Document consumer APIs and drop outdated text Kuan-Wei Chiu
2026-03-17 14:53 ` Jonathan Corbet [this message]
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=87se9ycxsx.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=aarontian@google.com \
--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=visitorckw@gmail.com \
--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