From: Michael Kelley <mhklinux@outlook.com>
To: Christoph Hellwig <hch@lst.de>
Cc: "robin.murphy@arm.com" <robin.murphy@arm.com>,
"joro@8bytes.org" <joro@8bytes.org>,
"will@kernel.org" <will@kernel.org>,
"m.szyprowski@samsung.com" <m.szyprowski@samsung.com>,
"corbet@lwn.net" <corbet@lwn.net>,
"iommu@lists.linux.dev" <iommu@lists.linux.dev>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
"petr@tesarici.cz" <petr@tesarici.cz>,
"roberto.sassu@huaweicloud.com" <roberto.sassu@huaweicloud.com>
Subject: RE: [PATCH v2 1/1] Documentation/core-api: Add swiotlb documentation
Date: Fri, 26 Apr 2024 16:29:35 +0000 [thread overview]
Message-ID: <SN6PR02MB415775F2F7B865162D7A534DD4162@SN6PR02MB4157.namprd02.prod.outlook.com> (raw)
In-Reply-To: <20240426061852.GA5645@lst.de>
From: Christoph Hellwig <hch@lst.de> Sent: Thursday, April 25, 2024 11:19 PM
>
> On Wed, Apr 24, 2024 at 08:02:53AM -0700, mhkelley58@gmail.com wrote:
> > From: Michael Kelley <mhklinux@outlook.com>
> >
> > There's currently no documentation for the swiotlb. Add documentation
>
> s/the // ? (note that this is used in quite a few places)
OK. I'll drop using "the" before "swiotlb".
>
> Can you use up the full 80 characters for your text? As-is it reads a
> little odd due to the very short lines.
Will do.
>
> The other thing that strikes me as odd is the placement in the core-api
> directory together with other drivers-facing documentation. Swiotlb
> is internal to the dma-mapping subsystem and not really what is a core
> API. I don't really know where else it should be placed, though - nor
> do I really understand the "modern" hierarchy in Documentation, but maybe
> Jon has a good idea?
I also wasn't happy with it going under "core-api". But I agree with Jon's
comments. The affinity with the DMA documentation is strong, and in
the absence of a better place, I'll keep it under core-api.
Michael
>
> Except for these nitpicks the documentation looks good to me, thanks
> a lot!
prev parent reply other threads:[~2024-04-26 16:29 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-24 15:02 [PATCH v2 1/1] Documentation/core-api: Add swiotlb documentation mhkelley58
2024-04-25 9:13 ` Bagas Sanjaya
2024-04-26 6:18 ` Christoph Hellwig
2024-04-26 12:56 ` Jonathan Corbet
2024-04-26 16:29 ` Michael Kelley [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=SN6PR02MB415775F2F7B865162D7A534DD4162@SN6PR02MB4157.namprd02.prod.outlook.com \
--to=mhklinux@outlook.com \
--cc=corbet@lwn.net \
--cc=hch@lst.de \
--cc=iommu@lists.linux.dev \
--cc=joro@8bytes.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=m.szyprowski@samsung.com \
--cc=petr@tesarici.cz \
--cc=roberto.sassu@huaweicloud.com \
--cc=robin.murphy@arm.com \
--cc=will@kernel.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).