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

["Fabio M. De Francesco" <fmdefrancesco@gmail.com>]

On lunedì 18 aprile 2022 16:43:05 CEST Mike Rapoport wrote:
> Hi,
> 
> On Mon, Apr 18, 2022 at 09:53:04AM +0200, Fabio M. De Francesco wrote:
> > `scripts/kernel-doc -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-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) move the kernel-doc comments from highmem.h 
to
> > highmem-internal.h (which is the file were the kunmap_atomic() macro is
> > actually defined), merge it with the comment which already was in
> 
>                    ^ (2) ?
> 
> > highmem-internal.h, and (3) replace "@addr" with "@__addr".

Hi Mike,

It looks like these days I'm a bit distracted...
I'm about to send a v2 patch.

> 
> There is also replacement of "addr" with "page", so I'd phrase (3) as
> "use correct parameter names"

Yes, correct, I missed this too :(

>  
> > Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
> 
> Other than that
> 
> Acked-by: Mike Rapoport <rppt@linux.ibm.com>

Thanks for your "Acked-by:" tag.

Regards,

Fabio

> > ---
> >  include/linux/highmem-internal.h | 14 +++++++++++---
> >  include/linux/highmem.h          | 13 +------------
> >  2 files changed, 12 insertions(+), 15 deletions(-)
> > 
> > [snip]