linux-kernel - Re: [PATCH v1 09/17] docs: core-api: document the IOVA-based 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: <87h68hwkk8.fsf@trenco.lwn.net>
Date: Fri, 08 Nov 2024 13:13:27 -0700
From: Jonathan Corbet <corbet@....net>
To: Leon Romanovsky <leon@...nel.org>
Cc: Jens Axboe <axboe@...nel.dk>, Jason Gunthorpe <jgg@...pe.ca>, Robin
 Murphy <robin.murphy@....com>, Joerg Roedel <joro@...tes.org>, Will Deacon
 <will@...nel.org>, Christoph Hellwig <hch@....de>, Sagi Grimberg
 <sagi@...mberg.me>, Keith Busch <kbusch@...nel.org>, Bjorn Helgaas
 <bhelgaas@...gle.com>, Logan Gunthorpe <logang@...tatee.com>, Yishai Hadas
 <yishaih@...dia.com>, Shameer Kolothum
 <shameerali.kolothum.thodi@...wei.com>, Kevin Tian <kevin.tian@...el.com>,
 Alex Williamson <alex.williamson@...hat.com>, Marek Szyprowski
 <m.szyprowski@...sung.com>, Jérôme Glisse
 <jglisse@...hat.com>, Andrew
 Morton <akpm@...ux-foundation.org>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, linux-block@...r.kernel.org,
 linux-rdma@...r.kernel.org, iommu@...ts.linux.dev,
 linux-nvme@...ts.infradead.org, linux-pci@...r.kernel.org,
 kvm@...r.kernel.org, linux-mm@...ck.org
Subject: Re: [PATCH v1 09/17] docs: core-api: document the IOVA-based API

Leon Romanovsky <leon@...nel.org> writes:

>> So, I see that you have nice kernel-doc comments for these; why not just
>> pull them in here with a kernel-doc directive rather than duplicating
>> the information?
>
> Can I you please point me to commit/lore link/documentation with example
> of such directive and I will do it?

Documentation/doc-guide/kernel-doc.rst has all the information you need.
It could be as simple as replacing your inline descriptions with:

  .. kernel-doc:: drivers/iommu/dma-iommu.c
     :export:

That will pull in documentation for other, unrelated functions, though;
assuming you don't want those, something like:

  .. kernel-doc:: drivers/iommu/dma-iommu.c
     :identifiers: dma_iova_try_alloc dma_iova_free ...

Then do a docs build and see the nice results you get :)

Thanks,

jon