From patchwork Thu Jan 5 12:04:24 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: 13089744 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 8FF07C3DA7A for ; Thu, 5 Jan 2023 12:04:36 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 08DA38E0002; Thu, 5 Jan 2023 07:04:36 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 03DBD8E0001; Thu, 5 Jan 2023 07:04:35 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id E4A478E0002; Thu, 5 Jan 2023 07:04:35 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id D40EB8E0001 for ; Thu, 5 Jan 2023 07:04:35 -0500 (EST) Received: from smtpin06.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id 8F95F40ABB for ; Thu, 5 Jan 2023 12:04:35 +0000 (UTC) X-FDA: 80320613310.06.93F2984 Received: from mail-wm1-f42.google.com (mail-wm1-f42.google.com [209.85.128.42]) by imf23.hostedemail.com (Postfix) with ESMTP id 0A4C314000F for ; Thu, 5 Jan 2023 12:04:33 +0000 (UTC) Authentication-Results: imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=Y4WKlkMX; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of fmdefrancesco@gmail.com designates 209.85.128.42 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=1672920274; 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=HsXFSE5iuKwcFVE4uqAdahcBtbjYOXocUo7GZr/5XYM=; b=yKQxF4Xet3wTeOfs1Lnm/n7hE+vCIZhhPIzp/WnWj4g79SYA3VqUVrYNnRmRxtMbZLMcHD cIBwj7/KM+AfKm4ASgTBMaPkChkKERIVk4gA5P0htV4HFRnnTsQKSff7GtD23rl8xYzRct siwZbsWuVmgF0Ep6f6Idfv+450tNRzY= ARC-Authentication-Results: i=1; imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=Y4WKlkMX; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of fmdefrancesco@gmail.com designates 209.85.128.42 as permitted sender) smtp.mailfrom=fmdefrancesco@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672920274; a=rsa-sha256; cv=none; b=o298urBn1UdVtiF4i0XcfVuvmrZetEda2cWz3GKx9t1GfwUbY/PCbfl9uNIOVvZ7jKgYFa /IS/vlnN0UL7xC7ZPlva6StqES3gfUHczv/cLR/LfNFFqAmwqJHQuVpYs3GI+Af1V+KvXm +NtqOHwr46H3iKWl5eLp9q/cvmiU8R4= Received: by mail-wm1-f42.google.com with SMTP id ay2-20020a05600c1e0200b003d22e3e796dso1152009wmb.0 for ; Thu, 05 Jan 2023 04:04:33 -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=HsXFSE5iuKwcFVE4uqAdahcBtbjYOXocUo7GZr/5XYM=; b=Y4WKlkMXpKB95jYUM7a2KbvSpv40y7L8ji+ExPAp3xgNswgaDKQZHOhnN32CzsZ40C q2lmkk5XAMq2HuzftvxiWFM4JPi/tCuFYS0ofvaGsiSvXX7hw8tO9bkrdd+gW7/9u5P0 Y8hwTMxw/f/oH9fJokaMl5sauhKhksNXnqUxF6g6VsBgwUW81kO9SDExsESrqafqd6kB 9vsj9vCl+JSjZ5PN7ycwgFCb9cCjV5TlTsN7zV8lTGz6JJW6o/H3VURkSwNAtluazo0m /CvPsCGT2u+WP7IUtCZ3Gs+i8L+88SQnurPui3Hm3BWoT+1WBLtuCn0BsyQFM5mpuy9g LtTA== 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=HsXFSE5iuKwcFVE4uqAdahcBtbjYOXocUo7GZr/5XYM=; b=s9aIdTEQa5HQP3giE1/wRaSSe2Wn6sQ3lCuRgbQXWvIhTK/uTfchMk10inus5VSLFQ v8fAFuEdfWViEvPWfXxLMJufWdyZ5Tnyis3zPadbNpzfQCOcRgX4J6AITMpG49UPe6zw Ww9lFjHSB489zOPhjffLOPQJIUuECLVX8/hcBauc8uoxkjLtOR47xpNlc84JMpjlfr0E xfqHC54wKHcHB4SqI+H2yRvLZqQ7AVFpAFrVC+sS7aowWcyleMFRTKGzCVucfFYTAvAw N9xW8EjtjCfmhaFhs7WMMPW81WpCuJguDHLTTSevYPg7OW1ndfXszRr0NpbgFrrpwbeO aWFA== X-Gm-Message-State: AFqh2kpcx03epfaHA43af5UFzEMRAv5w2+2ma4wvdagd91jCD4zHYrl3 Ud/t8DuH+ke4G/+S9kgdlDg= X-Google-Smtp-Source: AMrXdXs3OPBu+GaIEgHEOC5Hl6HchU5paceNupPm5BaJdfMkFe/phu4WcT1P82cdlyzSFfKXPGPcGg== X-Received: by 2002:a05:600c:13ca:b0:3d3:4427:dfbf with SMTP id e10-20020a05600c13ca00b003d34427dfbfmr35457387wmg.5.1672920272413; Thu, 05 Jan 2023 04:04:32 -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 z25-20020a1c4c19000000b003d1e1f421bfsm2196388wmf.10.2023.01.05.04.04.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 04:04:31 -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 v2] mm: Remove an ambiguous sentence from kmap_local_folio() kdocs Date: Thu, 5 Jan 2023 13:04:24 +0100 Message-Id: <20230105120424.30055-1-fmdefrancesco@gmail.com> X-Mailer: git-send-email 2.39.0 MIME-Version: 1.0 X-Rspamd-Queue-Id: 0A4C314000F X-Rspamd-Server: rspam09 X-Rspam-User: X-Stat-Signature: 6dm93t9zkmhxxyrexyczccfh9smbagoq X-HE-Tag: 1672920273-956024 X-HE-Meta: U2FsdGVkX1871cSYTuQzxzOnuGvRm5vn1B6XBFEy8s6KJIcHZ9Z6oCbH9x6mAhTqNf7KzwGxGUOu2OseltEEQduM4UV55p8+pDxjXWgeF/O/SzHVo+XALyntRNIyprjTPIW4Nhtl+aBOulZno745lbQI5Y9U8DJO6+Ush6ryFiq5vBrUwBYixqskG9U8nkQAUhG6ek8OtS/DRTsEiaA119ooBkWVxPWNddYuOIpGJdbILew6KA1a9OpqqI/HkET21mNd8xyMIiRZWeSWtsvtU/Na40nleq6SAID4VTOBTDA0GfUDW6KGdpaVSkCPnBM26N+BlE7ooA0OS3wyNI++xnUytHKrm5TywJofnVK/OF4jdCkvMMxBexdfPRl1P+5SXeYXLNm4DbIyOnF5eBJSygAioAjsqDY6IsIzPDjPQkygo/AqaAIm58VT616MRPagQ9+2rNGQFXelfy3M6IA0ST5skEU6yCe+44vhPYAdyf5JDiQqdCnvxVPzEkLStQXbC4WxU4+nIRWG+BnW9El5kDC/xuSxqR+ThLZPP0soqcPdxvLtyOoE3wTJvpgTGrruPSUk/NQv9JymE7XnmherD0t+Ig9kqP9FlNMdwKu3uekCTi+1Q2OGOXZjSiUpPdCGW0RyRVWHYOHO3JZGMNPrObF7M63g89zf6qE3ePNoyUTrvVWTC1PxOfSUGnrVr7Y+qYuUOUgRyc19DUXnKfCzVWwGTlq9n7n/LWhU2MNz48rxo5O5ctk4kqCL/gfWpbPkhcYgvAXoSLwmQrGtNESWJc1CXZvVLDaJEb02JVRRokqiBaM1u6CK/jcgO45NipP8PkrLT4rhNWJ96BYuvEO9flRJJABsxgjTo0xq8ff+DKVC/4bMnQ9MvfwRF2FZal8kSyJX2DngoPQbGxY6sa8DM2O6YuosW0tlFTBz3/R3BgDNm1zV1W1gL8GTtJfL0GmLVFfNugc/GfWqFwWfGbz FzORii3K a/7UqIbPy3iGdIL49TIMTGxgUbN23d590BII3R5dFbzyVWsojOPHamXJO/oVfKZRp6LCMZp09lajvdjqUL1LQ0UFrDGWcMfOPUS3UstEAWJW46uv9y2IgXQLQfGY+Tr0WfHt6z2UMZSH6xev26Dcu/fd6sCqvZhPgDPrdBUDwRXVIMD8= 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 exactly how it has previously been done for the kmap_local_page() kdocs in commit 72f1c55adf70 ("highmem: delete a sentence from kmap_local_page() kdocs"). Cc: Ira Weiny Cc: Matthew Wilcox (Oracle) Signed-off-by: Fabio M. De Francesco Reviewed-by: Ira Weiny --- 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