mm: Remove an ambiguous sentence from kmap_local_folio() kdocs
Subsystems (2)
PATCH v2 1/1 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").
--- include/linux/highmem.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
include/linux/highmem.h +1 -2
@@ -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
Signature · 1 line
2.39.0
Quoted 7 lines · Fabio M. De Francesco
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()andkmap_atomic()are deprecated, bothkmap_local_folio(), as well askmap_local_page(), must be preferred to the previous ones.
Quoted 5 lines
Therefore, remove the above-mentioned sentence exactly how it has previously been done for the
kmap_local_page()kdocs in
commit72f1c55adf70("highmem: delete a sentence fromkmap_local_page()kdocs").Cc Ira Weiny <[email protected]>
Quoted 23 lines
Cc Matthew Wilcox (Oracle) <[email protected]>Signed-off-by Fabio M. De Francesco <[email protected]>--- include/linux/highmem.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)include/linux/highmem.h +1
-2@@ -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 Signature · 1 line
2.39.0