| Message ID | 20230105120424.30055-1-fmdefrancesco@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | [v2] mm: Remove an ambiguous sentence from kmap_local_folio() kdocs | expand |
On Thu, Jan 05, 2023 at 01:04:24PM +0100, Fabio M. De Francesco wrote: > 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 <ira.weiny@intel.com> Reviewed-by: Ira Weiny <ira.weiny@intel.com> > Cc: Matthew Wilcox (Oracle) <willy@infradead.org> > Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com> > --- > 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 > -- > 2.39.0 >
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
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 <ira.weiny@intel.com> Cc: Matthew Wilcox (Oracle) <willy@infradead.org> Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com> --- include/linux/highmem.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)