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] [thread-next>] [day] [month] [year] [list]

Message-ID: <874jbop9iq.fsf@meer.lwn.net>
Date: Fri, 26 Apr 2024 06:56:45 -0600
From: Jonathan Corbet <corbet@....net>
To: Christoph Hellwig <hch@....de>, mhklinux@...look.com
Cc: robin.murphy@....com, joro@...tes.org, will@...nel.org, hch@....de,
 m.szyprowski@...sung.com, 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

Christoph Hellwig <hch@....de> writes:

> 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?

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