[PATCH] mm: Remove a sentence from kmap_local_folio() kdocs

[PATCH] mm: Remove a sentence from kmap_local_folio() kdocs

[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() 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 <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

Re: [PATCH] mm: Remove a sentence from kmap_local_folio() kdocs

[Matthew Wilcox]

On Wed, Jan 04, 2023 at 01:18:45PM +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".

Looks like you removed it from kmap_local_page() docs in 72f1c55adf70
after I copied it in 53c36de0701f.  That information should probably
also be in this changelog.

>   * While it is significantly faster than kmap() for the higmem case it

Also, s/higmem/highmem/ (both in the kmap_local_page() and
kmap_local_folio() docs)

Re: [PATCH] mm: Remove a sentence from kmap_local_folio() kdocs

[Fabio M. De Francesco]

On mercoledì 4 gennaio 2023 15:40:26 CET Matthew Wilcox wrote:
> On Wed, Jan 04, 2023 at 01:18:45PM +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".
> 
> Looks like you removed it from kmap_local_page() docs in 72f1c55adf70
> after I copied it in 53c36de0701f.  That information should probably
> also be in this changelog.
>
Matthew,
 
I just added that information in v2 (I didn't know that I should have better 
added it - thanks for letting me know about this practice): 
https://lore.kernel.org/lkml/20230105120424.30055-1-fmdefrancesco@gmail.com/
>
> >   * While it is significantly faster than kmap() for the higmem case it
> 
> Also, s/higmem/highmem/ (both in the kmap_local_page() and
> kmap_local_folio() docs)
>
Since these spelling mistakes are un-related to the purpose of the deletion, I 
fixed them in a separate patch:
https://lore.kernel.org/lkml/20230105121305.30714-1-fmdefrancesco@gmail.com/

Again thanks for commenting my patch and suggesting improvements.

Fabio