Re: [PATCH 1/4] mm/highmem: Fix kernel-doc warnings in highmem*.h

[Fabio M. De Francesco]

On venerdì 22 aprile 2022 10:24:14 CEST Mike Rapoport wrote:
> On Thu, Apr 21, 2022 at 08:01:57PM +0200, Fabio M. De Francesco wrote:
> > `scripts/kernel-doc -v -none include/linux/highmem*` reports the 
following
> > warnings:
> > 
> > include/linux/highmem.h:160: warning: expecting prototype for 
kunmap_atomic(). Prototype was for nr_free_highpages() instead
> > include/linux/highmem.h:204: warning: No description found for return 
value of 'alloc_zeroed_user_highpage_movable'
> > include/linux/highmem-internal.h:256: warning: Function parameter or 
member '__addr' not described in 'kunmap_atomic'
> > include/linux/highmem-internal.h:256: warning: Excess function 
parameter 'addr' description in 'kunmap_atomic'
> > 
> > Fix these warnings by (1) moving the kernel-doc comments from highmem.h 
to
> > highmem-internal.h (which is the file were the kunmap_atomic() macro is
> > actually defined), (2) extending and merging it with the comment which 
was
> > already in highmem-internal.h, and (3) using correct parameter names.
> > 
> > Cc: Mike Rapoport <rppt@xxxxxxxxxxxxx>
> > Cc: Ira Weiny <ira.weiny@xxxxxxxxx>
> > Suggested-by: Matthew Wilcox <willy@xxxxxxxxxxxxx>
> > Signed-off-by: Fabio M. De Francesco <fmdefrancesco@xxxxxxxxx>
> > ---
> >  include/linux/highmem-internal.h | 14 +++++++++++---
> >  include/linux/highmem.h          | 15 +++------------
> >  2 files changed, 14 insertions(+), 15 deletions(-)
> >
> > [...]
> >
> > + *
> > + * Unmap an address previously mapped by kmap_atomic() and re-enables
> 
> Unmap ... and re-enable
> 
> or 
> 
> Unmaps ... and re-enables

Sorry, I should have read it twice before submitting :(

This entire series has already been taken by Andrew Morton for "-mm" 
immediately after submission. I think that probably the better suited 
solution is to send a correction when they show upstream. 

Do you agree with me or you prefer that I resubmit the whole series as a v2 
now?

> 
> Other than that
> 
> Acked-by: Mike Rapoport <rppt@xxxxxxxxxxxxx>
> 

I also saw your "Acked-by" tag in patch 2/4. Thanks!

Regards,

Fabio