From: Matthew Wilcox <willy@infradead.org>
To: Wren Turkal <wt@penguintechs.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Expose the bus kernel docs to the build docs.
Date: Sun, 7 Mar 2021 01:44:45 +0000 [thread overview]
Message-ID: <20210307014445.GT2723601@casper.infradead.org> (raw)
In-Reply-To: <20210307013301.39420-1-wt@penguintechs.org>
On Sat, Mar 06, 2021 at 05:33:01PM -0800, 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.
I think this is a good thing to do.
> +++ b/Documentation/driver-api/driver-model/bus.rst
> @@ -144,3 +144,5 @@ sysfs directory using::
>
> int bus_create_file(struct bus_type *, struct bus_attribute *);
> void bus_remove_file(struct bus_type *, struct bus_attribute *);
> +
> +.. kernel-doc:: include/linux/device/bus.h
Do you want to put a heading in front of it? I did this in xarray.rst:
Functions and structures
========================
.. kernel-doc:: include/linux/xarray.h
.. kernel-doc:: lib/xarray.c
Also, I see that drivers/base/bus.c is included in
driver-api/infrastructure.rst, and I feel that they should probably be
included together?
next prev parent reply other threads:[~2021-03-07 1:45 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-07 1:33 [PATCH] Expose the bus kernel docs to the build docs Wren Turkal
2021-03-07 1:44 ` Matthew Wilcox [this message]
2021-03-07 1:46 ` Wren Turkal
2021-03-07 3:12 ` [PATCH v2] " Wren Turkal
2021-03-07 3:16 ` Matthew Wilcox
2021-03-07 3:41 ` Wren Turkal
2021-03-08 19:14 ` [PATCH v3] " Wren Turkal
2021-03-09 20:15 ` Wren Turkal
2021-03-12 18:52 ` Wren Turkal
2021-03-15 19:29 ` 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=20210307014445.GT2723601@casper.infradead.org \
--to=willy@infradead.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=wt@penguintechs.org \
/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