Re: [PATCH v2 1/1] Documentation/core-api: Add swiotlb documentation

[Jonathan Corbet]

Christoph Hellwig <hch@xxxxxx> writes:

> On Wed, Apr 24, 2024 at 08:02:53AM -0700, mhkelley58@xxxxxxxxx wrote:
>> From: Michael Kelley <mhklinux@xxxxxxxxxxx>
>> 
>> 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