From patchwork Wed Jan 4 12:18:45 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Fabio M. De Francesco" X-Patchwork-Id: 13088541 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 510D8C46467 for ; Wed, 4 Jan 2023 12:18:56 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id CD4A38E0002; Wed, 4 Jan 2023 07:18:55 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id C85648E0001; Wed, 4 Jan 2023 07:18:55 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id B4CBD8E0002; Wed, 4 Jan 2023 07:18:55 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id A51B08E0001 for ; Wed, 4 Jan 2023 07:18:55 -0500 (EST) Received: from smtpin30.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id 7864B1C638D for ; Wed, 4 Jan 2023 12:18:55 +0000 (UTC) X-FDA: 80317020630.30.E33CE2F Received: from mail-wm1-f49.google.com (mail-wm1-f49.google.com [209.85.128.49]) by imf15.hostedemail.com (Postfix) with ESMTP id D932BA0008 for ; Wed, 4 Jan 2023 12:18:53 +0000 (UTC) Authentication-Results: imf15.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b="oLLNue/K"; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf15.hostedemail.com: domain of fmdefrancesco@gmail.com designates 209.85.128.49 as permitted sender) smtp.mailfrom=fmdefrancesco@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672834733; 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=LHMgOCfBnekqEjjX5jdxKzkmOrq/OhhRkWXkA6bEgN4=; b=fprHpCH42zURuz+pmMkyTA+HJBBGHUqL3WwRVo+brZ0yQERdr3qytTXmqoZYdV6RO6YwrZ wqxwBm4OvJ+Ff4jl707wad9R+GM0RDRN9Q8HQZYAwhOJVr4UWcuH11OduSDOTe1u7zcvLs zrjQI2YrlQrX4OEvqG66wo+iUciBOfk= ARC-Authentication-Results: i=1; imf15.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b="oLLNue/K"; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf15.hostedemail.com: domain of fmdefrancesco@gmail.com designates 209.85.128.49 as permitted sender) smtp.mailfrom=fmdefrancesco@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672834733; a=rsa-sha256; cv=none; b=sq9Q3geJ8Z9ONPwgB11iPp2fDgB7cAiYz+GGWeHjLmc/LhREE7vTZedU7E5C95AWWYBcQj 9c8KJBqWyWbbrlWRBHA/oWOjlxIpLKTZ0cR5j9coFWZ7+xybN8DOl0RzWipwZQpMwVCGoa OA5uSylVd2bh/ikRtT/+qe3ruX29kZE= Received: by mail-wm1-f49.google.com with SMTP id g10so11615273wmo.1 for ; Wed, 04 Jan 2023 04:18:53 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=LHMgOCfBnekqEjjX5jdxKzkmOrq/OhhRkWXkA6bEgN4=; b=oLLNue/KQ4/VRO/ad0YLFe6X5X7R8bP5WJ+JR5pjtM8F5JJKRljjVXm4CLTmRe8M06 8at6sfEtuxmBXbmzMG4Fqd8m/TCdiTxYKIdnuVBsPGOr8we4DmCa6jvi3Ef8tDn9kCfy UiEWF6R8BUi6bopmd44uGdzgSbonoxE3feericK8SWJxHUu3Vsw4xse7ZseaLds/YJ7i UCIKSvMSeHxCJSRJ8pqPvR8nt2s86fQ2aNjdc7I3P++n4hxoPIlN0mA9IpX9RCZH0zki ahKK6q+YUWcG+2yq3A4Y58IZXBuprVqmixq7xETu+nB+K/frul+Gk+ABj0LeJdrYh27S bnOQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=LHMgOCfBnekqEjjX5jdxKzkmOrq/OhhRkWXkA6bEgN4=; b=k7Pzbl4n9pHBnS8Ps14PH2Cl6NoQRUNu8rwIpe8Huf8GioC5HfZW/TJax77K7bX3v2 BKBo445OrcuDC+5cowabFCx0dsXvSO71dDSWmDAg0IEARGvXwXXckRiDXJWv9civpxbc 7Qc2moKjgB4pNj78WvNjZXwfO4FN+AQj1zAWLbiefB2ldKWExxyirnf9FRXvEnjpDMYD b6/ko3exIw4JGsfoCuMKXrdrUveqNgSXp6+6pztVfG1kVbyix4L/43Yc/pgRvM/Pa2SA JTMtbC63NikY4LKG6IQFjur57sE1b+XU8fA39Or2Er0t1gPwS0KvRLKhGmnzr1ILpXpN EpZw== X-Gm-Message-State: AFqh2kovN/aJYvC8vISMhWhtgyEnli79ApJrLy5FrNlLxUG/NDYZYDHm 2U3AYkpVUoROx5r5wQOC5L0= X-Google-Smtp-Source: AMrXdXvwQasIqJ6ZlDtE/7Ns0uTduzr20whGAySg10LTvFhXhHHQaifMllKQuKEoMCooKfcEd2Gvnw== X-Received: by 2002:a05:600c:3545:b0:3d9:a145:9ab with SMTP id i5-20020a05600c354500b003d9a14509abmr14213841wmq.39.1672834732345; Wed, 04 Jan 2023 04:18:52 -0800 (PST) Received: from localhost.localdomain (host-79-56-217-20.retail.telecomitalia.it. [79.56.217.20]) by smtp.gmail.com with ESMTPSA id h6-20020a05600c350600b003d990372dd5sm32570985wmq.20.2023.01.04.04.18.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 04 Jan 2023 04:18:51 -0800 (PST) From: "Fabio M. De Francesco" To: Andrew Morton , Ira Weiny , Sebastian Andrzej Siewior , Alexander Potapenko , Bagas Sanjaya , Andrey Konovalov , Tony Luck , linux-kernel@vger.kernel.org, "Matthew Wilcox (Oracle)" , linux-mm@kvack.org Cc: "Fabio M. De Francesco" Subject: [PATCH] mm: Remove a sentence from kmap_local_folio() kdocs Date: Wed, 4 Jan 2023 13:18:45 +0100 Message-Id: <20230104121845.15770-1-fmdefrancesco@gmail.com> X-Mailer: git-send-email 2.39.0 MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Server: rspam02 X-Rspamd-Queue-Id: D932BA0008 X-Stat-Signature: 8c1uqe1bqmmm47b6tu6ncqz6wty33c18 X-HE-Tag: 1672834733-550686 X-HE-Meta: U2FsdGVkX19fYgl+8Td7QBcmaBafQKKK4bZXlRltUpsvB5x02ke71+JUNIuH3ETjgdrlAP2UnR7KTgRyLjAHPCKKqsMMeHNFUe0HexX+1sJJgqq1d5kPFOaye6G9sn+yC99h0bgzcNeivGb1zLLa0Aby+iiOzqdutjOZUcMHhiUWR0bSnnYdWfxrzhlyFcYevPLI7EXkEgxGYjmQHiTyyIpGRqes8iM5P3QTzBPU+NqWeTcmFcYUn8v65O1OVfVDYdWY7+RhIaq3RP0UrQXFczGNkNAOLfES2oMGNhFx1ktb9wyTMP9hZMdTNHJavHTHC7SCt/4H+BMwLE2+eceRxdByVg8LQokvQ3Or7uo+/gkp3O/ox/uesw3Ji11y7vrqIkOOuaOc+dnf/l1KcWk9z0Ek7jF9OngDEXD4aNoYLgub7X8P/mP5kFDUw/5nQh+12C7spnwZqIhkonIWeCFeANCGZG+w4ASYpp50Vf+Oy28ajIfw2sYoWKnzhG1rpoE90Y7xslF932PthZS9rfLRIRpOaI/zsb2298f8+idJPL5HnMSoV8vxqdErXZqc7u24yWAdUJimy/EblG//AO6MJTOpcejBQyXydXi62ro85uTMXn5jpmsdXbj9wF3HBcnv7j71x1J8fNtae0zFwVQvtUolStqzf/54Dm7fhaflT8i9752/NU4MiddcaBHNNIQ9O6YnDaO1ZrHPltqn3d3G/TR4fa+YRiVMxreVOZS1CKO+AoHFgYIpyW5Nr0YBJM9Ppti5p8oAHx86FdN5gLVLjOvqAS0pDlfaI9bABw/cJXdCHple01rxW0umhtMOukQM7gtgL38sl09UGeu3xnNp722UBCWIR3QxXNWko8c2h4LwSC7MnuBRbgxVuXpGB2d4SUJo9+XBhcVdrYLF/x53MroaaUx7KFA+aczTmVhsAkaSS4Na9IiDkFeMxHMAF5nk35P8WC3+qTJKTUkhRJw IOJb7WJo 7FT6uOslq8tppiEZWWa58tOuSUgyQYdL/hM8WJF+eBImNR9+bj/5SW4nRj7wFM1P0ORMGFD17Ud/6OwQbF/P2xJuRHm1R6tk2Y1RHl0p6k+VtmpbikcwGs1iPlXMZRI5rNC6P+hPp8UajRHzIZEveMxrIuFFBspl9yvpPZUIQO01+ksw= 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: In the kdocs of kmap_local_folio() there is a an ambiguous sentence which suggests to use this API "only when really necessary". On the contrary, since kmap() and kmap_atomic() are deprecated, both kmap_local_folio(), as well as kmap_local_page(), must be preferred to the previous ones. Therefore, remove the above-mentioned sentence. Cc: Ira Weiny Cc: "Matthew Wilcox (Oracle)" Signed-off-by: Fabio M. De Francesco --- include/linux/highmem.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/include/linux/highmem.h b/include/linux/highmem.h index 44242268f53b..7b0085a61e67 100644 --- a/include/linux/highmem.h +++ b/include/linux/highmem.h @@ -120,8 +120,7 @@ static inline void *kmap_local_page(struct page *page); * temporarily mapped. * * While it is significantly faster than kmap() for the higmem case it - * comes with restrictions about the pointer validity. Only use when really - * necessary. + * comes with restrictions about the pointer validity. * * On HIGHMEM enabled systems mapping a highmem page has the side effect of * disabling migration in order to keep the virtual address stable across