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

From: Christoph Hellwig
Date: Fri Apr 26 2024 - 02:19:05 EST


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?

Except for these nitpicks the documentation looks good to me, thanks
a lot!