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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID:
 <SN6PR02MB415775F2F7B865162D7A534DD4162@SN6PR02MB4157.namprd02.prod.outlook.com>
Date: Fri, 26 Apr 2024 16:29:35 +0000
From: Michael Kelley <mhklinux@...look.com>
To: Christoph Hellwig <hch@....de>
CC: "robin.murphy@....com" <robin.murphy@....com>, "joro@...tes.org"
	<joro@...tes.org>, "will@...nel.org" <will@...nel.org>,
	"m.szyprowski@...sung.com" <m.szyprowski@...sung.com>, "corbet@....net"
	<corbet@....net>, "iommu@...ts.linux.dev" <iommu@...ts.linux.dev>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
	"linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>, "petr@...arici.cz"
	<petr@...arici.cz>, "roberto.sassu@...weicloud.com"
	<roberto.sassu@...weicloud.com>
Subject: RE: [PATCH v2 1/1] Documentation/core-api: Add swiotlb documentation

From: Christoph Hellwig <hch@....de> Sent: Thursday, April 25, 2024 11:19 PM
> 
> On Wed, Apr 24, 2024 at 08:02:53AM -0700, mhkelley58@...il.com wrote:
> > From: Michael Kelley <mhklinux@...look.com>
> >
> > 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!