From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 61481D64084 for ; Fri, 8 Nov 2024 20:27:47 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id DD25D6B00CD; Fri, 8 Nov 2024 15:27:46 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id D5B6F6B00D4; Fri, 8 Nov 2024 15:27:46 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id BD4106B00D5; Fri, 8 Nov 2024 15:27:46 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id 9A68F6B00CD for ; Fri, 8 Nov 2024 15:27:46 -0500 (EST) Received: from smtpin05.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id 4133780B1D for ; Fri, 8 Nov 2024 20:27:46 +0000 (UTC) X-FDA: 82764062850.05.28C6097 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf29.hostedemail.com (Postfix) with ESMTP id 5E89C120023 for ; Fri, 8 Nov 2024 20:26:54 +0000 (UTC) Authentication-Results: imf29.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=kQxdbUUk; spf=pass (imf29.hostedemail.com: domain of leon@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=leon@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1731097437; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=SuBwPflD5x1FjpVUqJMUPA8ij7fI5LEtqf+PEDxGKHw=; b=jfwqylcD6/vmCwg+Dago3ExXN2zxttPisMcfTg3UsUmvWl6X1jSLSF7Mmb6C4pEXgHnQ0W s29jQWcenNym+TjPa5BAGIKLcD0mZbaPxiE8/t6i0Ar1yJ5kuxJ4936eG+sb0u8mrZiC/Q tzVXutMJbc/B3bNvD0pmzqbrBlebr2I= ARC-Authentication-Results: i=1; imf29.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=kQxdbUUk; spf=pass (imf29.hostedemail.com: domain of leon@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=leon@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1731097437; a=rsa-sha256; cv=none; b=Erp02loerd3O0rwRlSiyqTUEqJ7M34agxD9yk1HWZXJyYmcFJI3rljPBDm9zi+b7g/5+Bv iAyvzw2d5Rye2Ga2TmHhopNKFPP2rcVtn32uqzpwEvD/hgsQQEs/nqvRZNCvayISGseoec qjFbcAtQMpkDFZkIksyciHTj47HIMuE= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id C15AB5C5E1C; Fri, 8 Nov 2024 20:26:58 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id D34E3C4CEEF; Fri, 8 Nov 2024 20:27:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1731097662; bh=fEkKlC8Hg48yKdWPTMBAlRN6pz1/ghsdZabweHXbhzQ=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=kQxdbUUkl22MhYJ7DwatoeDKWjNx/F1CJZOuLcFdp7LQvaPdVdHti+/hn/sheWd1+ CgCPfKci9ZZtTsEivm1eh8hhse4OzQu82g9Eo+eLUOy0LlG3gmIHJFv6Czp1bMK3OQ 67ei1ypM2zP7JkXKKaBNvFhdvLTvyEXfpc2fQrzlvSNPP8INjRX4G++0yeANG1bnXI vaDXlNFUIih+7l1wn1ZT8Zma+fi2I1SHUMIr3fOWOVKVI9GXzLI4dcX1J17510r/kq Ynakuwz3YuW6CL+ZtvWHtcGl1MD/ZSDtjDLhq8q6xZLi9xuaOGnDyb6OWJu4ygrF/P Z/t2NqXY6f9Pw== Date: Fri, 8 Nov 2024 22:27:36 +0200 From: Leon Romanovsky To: Jonathan Corbet Cc: Jens Axboe , Jason Gunthorpe , Robin Murphy , Joerg Roedel , Will Deacon , Christoph Hellwig , Sagi Grimberg , Keith Busch , Bjorn Helgaas , Logan Gunthorpe , Yishai Hadas , Shameer Kolothum , Kevin Tian , Alex Williamson , Marek Szyprowski , =?iso-8859-1?B?Suly9G1l?= Glisse , Andrew Morton , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-block@vger.kernel.org, linux-rdma@vger.kernel.org, iommu@lists.linux.dev, linux-nvme@lists.infradead.org, linux-pci@vger.kernel.org, kvm@vger.kernel.org, linux-mm@kvack.org Subject: Re: [PATCH v1 09/17] docs: core-api: document the IOVA-based API Message-ID: <20241108202736.GD189042@unreal> References: <881ef0bcf9aa971e995fbdd00776c5140a7b5b3d.1730298502.git.leon@kernel.org> <87ttchwmde.fsf@trenco.lwn.net> <20241108200355.GC189042@unreal> <87h68hwkk8.fsf@trenco.lwn.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <87h68hwkk8.fsf@trenco.lwn.net> X-Rspamd-Server: rspam06 X-Rspamd-Queue-Id: 5E89C120023 X-Stat-Signature: xgxx8zd1h6zjauei87kmq4yy5rd83pd8 X-Rspam-User: X-HE-Tag: 1731097614-602731 X-HE-Meta: U2FsdGVkX19b6gmOUjTjLaRqHy2N/pv1ey+TprsaD6VztmwbmlFvN8XW1hxrgSxtWK/hHXkOIBnJ+gdb2/5bvLS9/vc+UO2wctjhkv51vz+Y+eRVW4K9a1TumUiTKdV3wkNtFhp4p6279lbwh8UqH1uj2+0VFyA0M5vcFChDAZ5II5BWo63M8ZeUmX+3F5satzFuaMy8Mj9O9MV2eQG+42dKC5xUjPLzkVQVJOfcAzl1KJS78AXHDfY6IpSxT2GVxkAZNbjEW13s1rX0mcH2RvXLrDKG4Zb9v4lwXe/AsMUKgYC4gMz8GQHqW3df7lzLHDl3UmIADx6JjYCnTuVDwZa6cvHi7slGSU1z+TpyIcTeb8tup0l5Xx+ggcdEKeUL9u7tjF4wDhdOYYUxfiiiwLkf19OGbAe4JQtp1tIRfirSYjzD9ICPPzzwi4NT+7xWaL1/eGlppHHkIQPSCEmHfdsDEm9Lj5FeUDxJovFy9rYdXHftO0FUSW3tWikGHv/mtLS03OcivnViJXIXQUD9pmNfSJWJGUTaQHNTFBxl2L4H8k2ZUAeDgr5dJomgpM+Jh6xcCkW1YSAQiWDrFlm5zjZHOoIM7vpCgQwa+FsEfO8pE7W72J/TbGbNE5G1wGANmcjbSyEdt1iUPflcqxoWm6zVOcRjm64+9G3aaTfNLJRWvPeQLlk+hOAkHW810acR9BOxMJtxpDN5i5urJtWlJgX29vgkR4YreCofaALJgBcP09vsQsw/iZYQSSOga2gd0W+DkhF/MLrHZveGKlu+ZenOKppZNMsaE0ymWUAn2efdGdglv1xr1XJDy8b7XpyEpy6CyuX65oxx4aFMM5hXj6QehO991qHPaP9qnPHSh1etM41TtKeMvzeSh2lyh8lYYOtGqwx7MFWU9LjRk7oCvcB5m9SZHr+Z0kS+jrPBzOPwW9uqHKtPUxfybj6Q8IkJ/IU+Kx4EmtwbqdyRhUZ JtD1VwTS YEhIZe9WmwlWfnUAvEr/QdRE1XVhJleiOXETnhs6e8wZZFfVctGDGVtfxfoqGi5dWeeu4Ektj3P3fCjVMf72Zv/46dfh3Q7qLvVnaTYp8LJh0Y/cj53oZtSvJoTyDgoc6L/NVcoZ+Mdfl943RzjAr0OSqwvExiod1fEcWs5Vb1Eved9IVipRzh5SGQFTI237BAi6ogtl96EdgSOL1kkj1Dl2mah/WQzM4+7Dcsm84c3JnQu73fbd8j9Kwk+7owhCI/tksRL8PY2D90/Srs7quh1v+lQ== X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: On Fri, Nov 08, 2024 at 01:13:27PM -0700, Jonathan Corbet wrote: > Leon Romanovsky 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 for the explanation, will change it. > > Thanks, > > jon