summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorFabio M. De Francesco <fmdefrancesco@gmail.com>2023-01-05 15:04:24 +0300
committerAndrew Morton <akpm@linux-foundation.org>2023-01-19 04:12:54 +0300
commit9eefefd835e451d340f5e95bc14ffd68b9b99268 (patch)
treeeb7aa4cfa1afd1b6e19f3b60a6a93b17bbb2a4d9 /include
parent541e06b772c1aaffb3b6a245ccface36d7107af2 (diff)
downloadlinux-9eefefd835e451d340f5e95bc14ffd68b9b99268.tar.xz
mm: remove an ambiguous sentence from kmap_local_folio() kdocs
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"). Link: https://lkml.kernel.org/r/20230105120424.30055-1-fmdefrancesco@gmail.com Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com> Reviewed-by: Ira Weiny <ira.weiny@intel.com> Cc: Matthew Wilcox (Oracle) <willy@infradead.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Diffstat (limited to 'include')
-rw-r--r--include/linux/highmem.h5
1 files changed, 2 insertions, 3 deletions
diff --git a/include/linux/highmem.h b/include/linux/highmem.h
index 44242268f53b..daeb0d8e753a 100644
--- a/include/linux/highmem.h
+++ b/include/linux/highmem.h
@@ -119,9 +119,8 @@ static inline void *kmap_local_page(struct page *page);
* virtual address of the direct mapping. Only real highmem pages are
* 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.
+ * While it is significantly faster than kmap() for the highmem case it
+ * 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