public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Christoph Hellwig <hch@lst.de>, mhklinux@outlook.com
Cc: robin.murphy@arm.com, joro@8bytes.org, will@kernel.org,
	hch@lst.de, m.szyprowski@samsung.com, iommu@lists.linux.dev,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	petr@tesarici.cz, roberto.sassu@huaweicloud.com
Subject: Re: [PATCH v2 1/1] Documentation/core-api: Add swiotlb documentation
Date: Fri, 26 Apr 2024 06:56:45 -0600	[thread overview]
Message-ID: <874jbop9iq.fsf@meer.lwn.net> (raw)
In-Reply-To: <20240426061852.GA5645@lst.de>

Christoph Hellwig <hch@lst.de> writes:

> 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)
>
> Can you use up the full 80 characters for your text?  As-is it reads a
> little odd due to the very short lines.
>
> 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 hadn't thought about it, but it seems that putting it with the rest of
the DMA-API documentation would make sense.  That's core-api, at the
moment at least...

Thanks,

jon

  reply	other threads:[~2024-04-26 12:56 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 [this message]
2024-04-26 16:29   ` Michael Kelley

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=874jbop9iq.fsf@meer.lwn.net \
    --to=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=mhklinux@outlook.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