Received-SPF: pass (google.com: domain of linux-kernel+bounces-160005-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
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
In-Reply-To: <20240426061852.GA5645@lst.de>
References: <20240424150253.560999-1-mhklinux@outlook.com>
 <20240426061852.GA5645@lst.de>
Date: Fri, 26 Apr 2024 06:56:45 -0600
Message-ID: <874jbop9iq.fsf@meer.lwn.net>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

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