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 6BF5AD65C42 for ; Thu, 14 Nov 2024 06:12:28 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id C58AC6B0088; Thu, 14 Nov 2024 01:12:27 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id C07D86B0089; Thu, 14 Nov 2024 01:12:27 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id ACFC06B008A; Thu, 14 Nov 2024 01:12:27 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 889EA6B0088 for ; Thu, 14 Nov 2024 01:12:27 -0500 (EST) Received: from smtpin26.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id D5DD640FA4 for ; Thu, 14 Nov 2024 06:12:26 +0000 (UTC) X-FDA: 82783679790.26.3611851 Received: from desiato.infradead.org (desiato.infradead.org [90.155.92.199]) by imf12.hostedemail.com (Postfix) with ESMTP id C8E2540391 for ; Thu, 14 Nov 2024 06:12:04 +0000 (UTC) Authentication-Results: imf12.hostedemail.com; dkim=pass header.d=infradead.org header.s=desiato.20200630 header.b=aRSr+GmG; spf=none (imf12.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 90.155.92.199) smtp.mailfrom=rdunlap@infradead.org; dmarc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1731564601; 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:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=jUCKr6wUh2Tqi3yTL8VvbBPynxI0kl0wP1daAbyP1eg=; b=7Z+uyYehjZLoRDdWYEZdLsX+a7jNkXa6Q3pgf/6Bst7GSRRL17vm3hQc6cuSAO/xOnXxSf I//KH9eAuRbJERjB1RQI6etHWr1h9c04GNR8yjoY23KCUKD2ugo1Wvz+tcZhZFCUap/M4h 3b6KJ7vcXw/MbNSRdYYolcLdFgDZ+zc= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1731564601; a=rsa-sha256; cv=none; b=dREjnGD65eDkoUr6UeJW2f4XOUgZpsqcwngmZTus9kG8ioLERIjnVSOuOuo2UNBG6Mi7/i OBZT1I+qM4F3uZdbOAVA4NzWP8RnSb/wk+RUIf1NQr5brphx933I1I0cuECpAtQubme+tE 7KOvdu5sVQ20n9mG67I5GqN0KqsFc7U= ARC-Authentication-Results: i=1; imf12.hostedemail.com; dkim=pass header.d=infradead.org header.s=desiato.20200630 header.b=aRSr+GmG; spf=none (imf12.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 90.155.92.199) smtp.mailfrom=rdunlap@infradead.org; dmarc=none DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=desiato.20200630; h=Content-Transfer-Encoding:Content-Type :In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date:Message-ID: Sender:Reply-To:Content-ID:Content-Description; bh=jUCKr6wUh2Tqi3yTL8VvbBPynxI0kl0wP1daAbyP1eg=; b=aRSr+GmGFu7GRcY5RjFrI3eIO4 O5rA2/ajbuSJL0fT2dlGd4tycHNUiXiUT7k42c3w4HZyTmBnp5ppdRDvtroQW3RtsKyxlepAFnsN4 qzcm088o5tV06tT/FRub4nipJ6UEforI6ACAEV44GqG4SOXtsvXBWSZD1TuP87W+w4IiAvxFxA6vd oxzF+WWSBEGBzBoJE7q2aOC4ojeIdTDNmfV/dtkr1urIpI9QFHyDX6zaWQThRwvRGLwJijAd5Mte1 s7aSdIO6GHfwWHmnUhrAic7AcMnAW6PNOEGXtqQTYnzQEbj5uU+rQ93+sHCJ5FrjMS7tCA7wi0wkz hzzay00g==; Received: from [50.53.2.24] (helo=[192.168.254.17]) by desiato.infradead.org with esmtpsa (Exim 4.98 #2 (Red Hat Linux)) id 1tBT5U-0000000DSOl-31ER; Thu, 14 Nov 2024 06:12:17 +0000 Message-ID: Date: Wed, 13 Nov 2024 22:12:12 -0800 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [RFC PATCH 0/2] modernize DMA api documentation To: anish kumar , corbet@lwn.net, tj@kernel.org, akpm@linux-foundation.org, ptesarik@suse.com, xavier_qy@163.com, vbabka@suse.cz, tintinm2017@gmail.com Cc: linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org References: <20241113063425.21042-1-yesanishhere@gmail.com> Content-Language: en-US From: Randy Dunlap In-Reply-To: <20241113063425.21042-1-yesanishhere@gmail.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Rspam-User: X-Rspamd-Server: rspam12 X-Rspamd-Queue-Id: C8E2540391 X-Stat-Signature: au81t5p3m17a9zdh1a7m7ju6c18ycs79 X-HE-Tag: 1731564724-597713 X-HE-Meta: U2FsdGVkX1++zTwxr04rMM5sMIlpZE5J9L6MmJvnyOqCU1njJaNS/r4IJOh7oBsrPDKCqvbEuOiIi6AUG1Lb3Isb94D8It+BHcQuq1YUmOe2W/Y5+8aIds49L4gJKDnXo2L3HX6XEe/uDasXodMcGMWbjYMkqMNrFz4fa658GTGD+8s/eaITYBlmUXRFqbokNcG8TeouWUohn8AXAKKMBEmmBM3SsoIaAYkX5IWyg5oFpqjSOyqWStg69FSikDhYgydnI6g2nlbomgcJJ9Ed+6DFcAtcC8cXvfFPNlUQ0y1Ue11g5nINX63ZGTnkpl9bRvMtCx7J72u/0MRnpNzuooA7re5Z1B5rt6OG+eE6idAeCwvn3OrI3106ZCEbJJVrFOvjY04AEpzCgXmD8HRGfvnR+fXAXy5YkJsddkT72z96tFhtj9YuCLYIO+buGayhDHISLu82r2uzW8fu3aosxl3rJz+B7up4xy2gabAUN3A+womVMi3XEJ5Ilg5RlAnTNwtI/FcYmKR7XfX7f0rZ9CH1pTMzHLeh08O9ysXjuJpARPy+tsFB4PtdcXJdI2SYjsYlK0xbODOYcmxNdsfbNwlP+SmBDrcI8icqAOk91QNN8hPtROAyZCMXaw42MvHCPODhGd2wIf+hMgBysQDgA3JW+hCnm+C9Po06St0Xd1rGQp5OFNiZ3+oZh1puVzbJ9TzLydm879/fPb6ayq6PpjDSsKdCYMggNR4nqEiXJEj+ib5RSGZZ95y/t0w3YcDvbhOvHV/TdDpi8YNTewW5rzT7qpGZP3AVNBh73vllnJtOqTxpGN5zhwZDyaYT4WrNwC0R/2ivYbOF98/VExZraX+92yBrxBOCz2VyTXURBEW/uZDfokh2XUeX4lTvYSbK4O/qn6QQOqUJFge1owID+yWI8wZNB2EypvXip3cdGq6Zp2g20g2wGbEEta7olkb7wIKp0oE1Aow3ABw06h+ fKicT2DB WhyNDri/wLMBubxthUb/8IMtnfydFPgNaKpTOrbEYrXJlCaol9THmI7gLRfFeRuhQF1czinWdDJmB41meSTAuhosHP3FHU8skWfuunWqhj5QmwtLIUEPl7PDTWit7K8+ekN2gl6Y9OdF4Y6RPF9WzWMlvORK9QFKWoC5I7kGWuoEPjsd3SMttpl/2o3IJ3S4+NPpTNiZOhRWDkHuDdvWHMY10Xnb7G3ikjEscfm4wv95tZa7HYl8x+zClSInIiX01uLCcqf+p1ORbX/LXf6GRnEK6VXPanQYHcrvuJ92kJIb/Tg0GwVsiAjSC7mpbSqRqLPG1 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: Hi-- On 11/12/24 10:34 PM, anish kumar wrote: > Dear maintainers, > > This patch series is inspired by the ongoing discussion in the following thread: > https://lore.kernel.org/lkml/20241111063847.GB23992@lst.de/ > > As part of an effort to modernize the documentation, the first patch in > this series converts the relevant document to use kernel-doc comments directly > within the source code, replacing the previous method of manually adding > documentation. This change will help streamline the documentation workflow and > ensure it remains synchronized with the code. > > I am still getting below errors and wondering if there is a better > way to write this patch. > > /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:89: > ./mm/dmapool.c:229: WARNING: Duplicate C declaration, also defined at > core-api/mm-api:224. Declaration is: > '.. c:function:: struct dma_pool *dma_pool_create (const char *name, > struct device *dev, size_t size, size_t align, size_t boundary)'. > > /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:92: > ./mm/dmapool.c:420: WARNING: Duplicate C declaration, also defined at > core-api/mm-api:404. Declaration is: > '.. c:function:: void *dma_pool_alloc (struct dma_pool *pool, gfp_t mem_flags, > dma_addr_t *handle)'. > > /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:98: > ./mm/dmapool.c:229: WARNING: Duplicate C declaration, also defined at > core-api/mm-api:224. Declaration is: > '.. c:function:: struct dma_pool *dma_pool_create (const char *name, > struct device *dev, size_t size, size_t align, size_t boundary)'. > > /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:101: > ./mm/dmapool.c:466: WARNING: Duplicate C declaration, also defined at > core-api/mm-api:450. Declaration is: > '.. c:function:: void dma_pool_free (struct dma_pool *pool, void *vaddr, > dma_addr_t dma)'. > > /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:104: > ./mm/dmapool.c:366: WARNING: Duplicate C declaration, also defined at > core-api/mm-api:360. > If you are going to add these APIs in dma-api.rst, you need to remove them from mm-api.rst (IMO). That should remove these Duplicate warnings. > Thank you for considering this patch. I look forward to your feedback. > > anish kumar (2): > dmapool: Improve dma api kernel-doc comments > dmapool: Documentation: use the kernel-doc comment > > Documentation/core-api/dma-api.rst | 66 ++++++------------------------ > mm/dmapool.c | 40 ++++++++++++------ > 2 files changed, 40 insertions(+), 66 deletions(-) > -- ~Randy