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 792E1C63797 for ; Fri, 6 Jan 2023 21:10:22 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id E71E58E0002; Fri, 6 Jan 2023 16:10:21 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id E21EB8E0001; Fri, 6 Jan 2023 16:10:21 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id CEA6C8E0002; Fri, 6 Jan 2023 16:10:21 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id BE4EE8E0001 for ; Fri, 6 Jan 2023 16:10:21 -0500 (EST) Received: from smtpin12.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 93E6AAB5F0 for ; Fri, 6 Jan 2023 21:10:21 +0000 (UTC) X-FDA: 80325617442.12.CDD7BC1 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) by imf19.hostedemail.com (Postfix) with ESMTP id 162741A000D for ; Fri, 6 Jan 2023 21:10:18 +0000 (UTC) Authentication-Results: imf19.hostedemail.com; dkim=pass header.d=infradead.org header.s=bombadil.20210309 header.b=5ERgl2Du; spf=none (imf19.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 198.137.202.133) 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=1673039419; 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=we4WDla0B8D5etYJgGObevY0Omm564e2/Rat8mfhIu8=; b=ltNetqkwhiz4PHIBUR6oCReiCg9p/LlmBsD4sT/YyKwVptMIgSo68HVQwO6kBu1+i5QGyR 5fC9w7Vk7rV1dZcM468BGM4mqvGCcAzKv5UUCbqpyOpMU5IlYT8V+YCINaq9MD8nYE1Xn4 YfFfxmtATKAw2vpynTIsuIxHme7LS0M= ARC-Authentication-Results: i=1; imf19.hostedemail.com; dkim=pass header.d=infradead.org header.s=bombadil.20210309 header.b=5ERgl2Du; spf=none (imf19.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 198.137.202.133) smtp.mailfrom=rdunlap@infradead.org; dmarc=none ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1673039419; a=rsa-sha256; cv=none; b=lw1aHuDpcDWryQWqBk3aUd3WwRBsWymOeD/nrKg23jAdK9YUJN+gRktBLFupO9IlntIhi/ vRF/VtRw+vgEEDGrqZhyHSO/oegechDBI4JE1eNUC6vYpxg205k+sAVG1mXzCDhq1cwwoG Xk3UBdmiSbcD7sBEjRzj/gSFA81tu0w= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; 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=we4WDla0B8D5etYJgGObevY0Omm564e2/Rat8mfhIu8=; b=5ERgl2DunrlCdl8nOHQFtVlztA ATQ3XG5oc9WnvC+DpHMRjx/pttuvsqpDlixP0IUlt/jypqVuGrFMboJYX4+zshs0u8aEu8MQajtaj K0viwhjiJXNMcRL3yB0VngEh57qRj1oT1sbmZoDjYIoAhGZSt00QMZICq57ZwFzSeTaJHQptx8mEi yHuc+OYRwtQjr2nGZ0TDXe4g1k3DndTTSWH5gpYtv2rWbGp+07qFIQWJYeMe9iZbHNP0gPU7IB+Aj 9Xw8cZq2iDQddEPvLkIBZDLN4ed91jigdCK11oAaxjUDCMMWYDVYejAGcaE164H1XQPFux4Kq4Yvr 5HpcLSjQ==; Received: from [2601:1c2:d80:3110::a2e7] by bombadil.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1pDtyf-00EyFG-IH; Fri, 06 Jan 2023 21:10:14 +0000 Message-ID: Date: Fri, 6 Jan 2023 13:10:12 -0800 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.6.1 Subject: Re: [PATCH] include/linux/mm: fix release_pages_arg kernel doc comment Content-Language: en-US To: SeongJae Park , akpm@linux-foundation.org Cc: linux-mm@kvack.org, linux-kernel@vger.kernel.org, corbet@lwn.net, linux-doc@vger.kernel.org References: <20230106203331.127532-1-sj@kernel.org> From: Randy Dunlap In-Reply-To: <20230106203331.127532-1-sj@kernel.org> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Stat-Signature: gjrf19wr7fzppe4rd1xacgciuf931mcf X-Rspam-User: X-Rspamd-Queue-Id: 162741A000D X-Rspamd-Server: rspam06 X-HE-Tag: 1673039418-935283 X-HE-Meta: U2FsdGVkX19Wh/3+86RhDmb7t2WK2lf7YUuS94cg1QUBDsG19LBuru0i7LC6V6jXfEqH/G3+0vqW7/uiS0OVKTZTaLAgxHKGnyGOzwYLVbSKa9T8Y5b5dvhegHaBOGS7Etp3NKZgnONGC/p3m14Kt9Z8OveHXI7tAXLpPH9PnpxMn9UtlF1p7R1pVZwKgwXoJBLhBB+AXehNE2lpDqCyvTLq2LW2aX6taO+Ic5X0f0fxTpSFhkS9lfizdkiAzWRWtJyzWn7T2r8kzf0FilWc5dV0Q/JGxNnLpXPy6IZsZ8FZcI9rhFkohxWeOrCyWC/oXlDcUMh81DfUcg5Khqh2hmNIGLaaGNgoFLCXNhUHl4b5/DwwyWeRxubX49C9h1aC2jN2wKI7Ed0k83xmn5NZF5ocFVi/ySl3ha9Usf/cNaZoSf0/vmn4+rjA4ps9cO8ybYanGvpH9yLAnnPYGuIWRq99zfjTKIgldbqbPiQZS9Mjm4V70ZfAQb4k8aG1fSlwPpifnwXN1tBQhXWgY/pmxgAMkWCsFyt65TJCrtRM9dg1yJJB+D7byQAJUVfPCYGNpHGUyPZY6U7TTQ0h5ALFGDS+JZKgI7CPrSPvDFl6kSDuV7j/ZtD/fYcTtaOtTs3SrcNNwRclJkVWwORsEpBcEtW2WtZsgw4bXKJI7PLoNc4hcHiJGtJButgJrOufNJC0onbG58fv87o6qGekMm7D++v/DK+EBmqkkGpvhXJxtQohe06JbG5JhbhSJ7TGratc5QhAhs5hGzrASWnxBV+uiWGZ1xL3LYR5twv4eUxjHOHkdMK/msuvrJZMnJz7jLPcc5yyRQyUEyZvPUwKccZzltKRW1PtTvSkvl+8B8FmgQKh8Q+Oe2/wBVoERFPnTmz0YOX32BTOhL0ygrJtCPomD4R1jO2AihvZ9pe5vSP7wkPN3zWilsBggw== 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: On 1/6/23 12:33, SeongJae Park wrote: > Commit 449c796768c9 ("mm: teach release_pages() to take an array of > encoded page pointers too") added the kernel doc comment for > release_pages() on top of 'union release_pages_arg', so making 'make > htmldocs' complains as below: > > ./include/linux/mm.h:1268: warning: cannot understand function prototype: 'typedef union ' > > The kernel doc comment for the function is already on top of the > function's definition in mm/swap.c, and the new comment is actually not > for the function but indeed release_pages_arg. Fixing the comment to > reflect the intent would be one option. But, kernel doc cannot parse > the union as below due to the attribute. > > ./include/linux/mm.h:1272: error: Cannot parse struct or union! > > Modify the comment to reflect the intent but do not mark it as a kernel > doc comment. > > Fixes: 449c796768c9 ("mm: teach release_pages() to take an array of encoded page pointers too") > Signed-off-by: SeongJae Park Acked-by: Randy Dunlap Thanks. > --- > include/linux/mm.h | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/include/linux/mm.h b/include/linux/mm.h > index a2bf261cdbef..3df8815f6d51 100644 > --- a/include/linux/mm.h > +++ b/include/linux/mm.h > @@ -1297,10 +1297,10 @@ static inline void folio_put_refs(struct folio *folio, int refs) > __folio_put(folio); > } > > -/** > - * release_pages - release an array of pages or folios > +/* > + * union release_pages_arg - an array of pages or folios > * > - * This just releases a simple array of multiple pages, and > + * release_pages() releases a simple array of multiple pages, and > * accepts various different forms of said page array: either > * a regular old boring array of pages, an array of folios, or > * an array of encoded page pointers. -- ~Randy