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

[Michael Kelley]

From: Christoph Hellwig <hch@xxxxxx> Sent: Thursday, April 25, 2024 11:19 PM
> 
> 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)

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!