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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <20240426061852.GA5645@lst.de>
Date: Fri, 26 Apr 2024 08:18:52 +0200
From: Christoph Hellwig <hch@....de>
To: mhklinux@...look.com
Cc: robin.murphy@....com, joro@...tes.org, will@...nel.org, hch@....de,
	m.szyprowski@...sung.com, corbet@....net, iommu@...ts.linux.dev,
	linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
	petr@...arici.cz, roberto.sassu@...weicloud.com
Subject: Re: [PATCH v2 1/1] Documentation/core-api: Add swiotlb
 documentation

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)

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!