linux-kernel - Re: [PATCH 5/8] docs: dma-api: remove duplicate description of the DMA pool API

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: <20250625084135.02a1ab09@mordecai.tesarici.cz>
Date: Wed, 25 Jun 2025 08:41:35 +0200
From: Petr Tesarik <ptesarik@...e.com>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: Jonathan Corbet <corbet@....net>, Morton <akpm@...ux-foundation.org>,
 Marek Szyprowski <m.szyprowski@...sung.com>, Leon Romanovsky
 <leon@...nel.org>, Keith Busch <kbusch@...nel.org>, Caleb Sander Mateos
 <csander@...estorage.com>, Sagi Grimberg <sagi@...mberg.me>, Jens Axboe
 <axboe@...nel.dk>, John Garry <john.g.garry@...cle.com>, "open
 list:DOCUMENTATION" <linux-doc@...r.kernel.org>, open list
 <linux-kernel@...r.kernel.org>, "open list:MEMORY MANAGEMENT"
 <linux-mm@...ck.org>
Subject: Re: [PATCH 5/8] docs: dma-api: remove duplicate description of the
 DMA pool API

On Tue, 24 Jun 2025 19:40:37 -0700
Randy Dunlap <rdunlap@...radead.org> wrote:

> Hi,
> 
> On 6/24/25 6:39 AM, Petr Tesarik wrote:
> > The DMA pool API is documented in Memory Management APIs. Do not duplicate
> > it in DMA API documentation.
> >   
> 
> This looks like it works (from just visual inspection), but I'm wondering
> why not just move all DMA API interfaces to dma-api.rst and don't have any
> in mm-api.rst... ?

That's also an option. As long as documentation is not repeated in more
than one place, I'm happy with the result. Now, seeing that it was you
who originally moved DMA pools from Drivers under Memory Management in
commit a80a438bd088 ("docbook: dmapool: fix fatal changed filename"), I
expect no complaints when I move it to dma-api.rst in v2.

Thanks for the idea!

Petr T