From patchwork Fri Jan 6 20:33:31 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13091816 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 B7674C3DA7A for ; Fri, 6 Jan 2023 20:33:40 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 47A958E0002; Fri, 6 Jan 2023 15:33:40 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 3DC9F8E0001; Fri, 6 Jan 2023 15:33:40 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 27E3E8E0002; Fri, 6 Jan 2023 15:33:40 -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 10E708E0001 for ; Fri, 6 Jan 2023 15:33:40 -0500 (EST) Received: from smtpin11.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id DB79916025D for ; Fri, 6 Jan 2023 20:33:39 +0000 (UTC) X-FDA: 80325524958.11.87406C2 Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by imf28.hostedemail.com (Postfix) with ESMTP id 53467C001A for ; Fri, 6 Jan 2023 20:33:38 +0000 (UTC) Authentication-Results: imf28.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=UfFy2UIy; spf=pass (imf28.hostedemail.com: domain of sj@kernel.org designates 145.40.68.75 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1673037218; 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-transfer-encoding:content-transfer-encoding: in-reply-to:references:dkim-signature; bh=yjuwzhMM4uGFYtJqpLgJbZI485ukMaO5b/nVCGUGNG0=; b=pzG6RLjg8URC8l4RvaZnMon4If864TCslBG2CsIynT5eRhtv03wJSMpb1KB/rXBHdYOy36 spKs7diR9fRCB9puGKeiozR4Evc2V54PnXmrmDBJKJi9PPPIzKvcez2vrG66wiQJIvBwfW 9JBHyorUeEdXiX01+rvFOBBUJWQ0/sg= ARC-Authentication-Results: i=1; imf28.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=UfFy2UIy; spf=pass (imf28.hostedemail.com: domain of sj@kernel.org designates 145.40.68.75 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1673037218; a=rsa-sha256; cv=none; b=SZ8/he5ciLmQnpCCuOhcTF4GvbQlo9VYPQEuKORR2MYSw0bj+uYqycN1yrsRW66YuV3oOV 19eLK/psdZEwryRdgVJEhL6mtVL6nZWJ4BVZh9WYUHNW2rQ5Zfqhw3h7SRXayqBW+gCOF9 skM7EVzj8lx5Ln2qCzV+QcxbdhQsHYU= Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id 7D04FB81E84; Fri, 6 Jan 2023 20:33:36 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id AD775C433EF; Fri, 6 Jan 2023 20:33:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1673037215; bh=70eLmqi50DwC4nGrPC6/BhJbdlKVrPt5HYhMfBWpJBc=; h=From:To:Cc:Subject:Date:From; b=UfFy2UIysVqCxWrNKjf2Jr8Hf6TtCep7aeD7mCO4w6TSdgK/anVbepYZjzWj+HtsT 8u+UnX/hBhFxGZ+OF4GB2Kq6td4lFIXgcWX4brSuw/vmUFoOeiSh6ZMMqyQHUFOeZ/ zzWrjqZBrRu1ujLDeVwLko5/4E4LNoFpth8IZQIYXYWCLiGa175VU8YIr9F0h51ATG S583TMR0011jHZ+wV3E3GmmxR7CJDmeRHGW3IFD/+10n6aDdg8uldIJX+OcXlGch6F dXnSFDryDTI5C6R8fGOU/AgJmR6cf7PXqZrYEsAnVLIedRtNKhOCWkPXlyOQbAnC5w CbVBv3EkdEdPw== From: SeongJae Park To: akpm@linux-foundation.org Cc: linux-mm@kvack.org, linux-kernel@vger.kernel.org, corbet@lwn.net, linux-doc@vger.kernel.org, SeongJae Park Subject: [PATCH] include/linux/mm: fix release_pages_arg kernel doc comment Date: Fri, 6 Jan 2023 20:33:31 +0000 Message-Id: <20230106203331.127532-1-sj@kernel.org> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 X-Stat-Signature: 8aknmpqqigfss836o7bcgd6xhsarqnen X-Rspam-User: X-Rspamd-Queue-Id: 53467C001A X-Rspamd-Server: rspam06 X-HE-Tag: 1673037218-537542 X-HE-Meta: U2FsdGVkX1++PozCOZ8/ziQKyhR2dTcef3Ukw7uOOD6/ABJGM66mdqTarAxZouYZ1Xwlb7DZFhtBoxitYFRafIwwdWka7NknlNdHcW4aGGlYksgWpCAWWDT8eJp2abHmkiLAQCWrMXjPQSmVQCi8INjc6BOCcI+rn78Wuczgc9KRpmgVjb7qysfvdLNtOyO6mMfdp717L1EcZc198dy3BY1BdeyU1Pb66nyKizWpQ1LPqnWrd4YC33BDalo4hRul6Flv/hjb3iDRtgZfxRJ8zdQas18F+FfqLB8BmayIiiGzXVvmiGPNFjJgfK27TnITJFYxb6g17OI0PriSD53OPHhwhwEKdI+4Pj0w6LMYym3i7rIQPh9BeL0M2ui+ryvjNHyifFQswpuHBemqVT6GdXAOFMWsb6GU5Rf5i+xxLuDcaxsc7+YZAkCBarTxRrs1QSTok2CFvc+OFeW9102MPAi+MXXFMxDgw99iUQiA0voDsUB48iI2npmtokOqS4NqgcGWZ0yzEkm7compuBCdd/KS9017VH5SzLqmsDClASf3Httkhu3y1d0pwz+OIkjOCyaLXNFi40bHdmqKV4V6ZBupNY/3ach02s6UqpP28Lw5XeTDexL1eqivcuYZVemVli5Ti3ymHVFF4PU2HNHQ5gS+reK1xDxyx6hyLwEcYshu3BZfRh7nRuV/L2HIbfKRbTGn48z5UW4Lo1hOaK4g62ITO49oy6Ws4Zc31yithMZnNQhq7DzojLXYkAsYyDPfGrZIBMpWsPyVp9Mh3sNkOAqmUiyQWiIfgklnQrwkTaanGcICO88RnSF+jrpWOmucZOFeMq0Z6rtPx34QjV86kGY1xD+3RsXMRUcmrVnw//EPKc7lUogfS7ldZMtPG8ykKpUl5rCH8eVmoXgv7lBqrJNIOPAfsgx8kC42tLTZ8s53UXNZFGwWW1WOrKCulLGhchmPm8X7z1xRNcYHvH9 1eMyEdSk PNY6wrRVK+TNIMSDYxdSwRk/v1HxIh7vBZiGxWS4NGOyq8bIxkJBfeOSbvlbfiYLWK/YNRbz9KW+rf6UIN7RRNoz55Dw4tFcl4fmMBT7Sil88MZIvXrQaMo2Vxg== 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: 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 --- 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.