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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <YmKETgjMzEOB2c+V@kernel.org>
Date:   Fri, 22 Apr 2022 13:32:46 +0300
From:   Mike Rapoport <rppt@...nel.org>
To:     "Fabio M. De Francesco" <fmdefrancesco@...il.com>
Cc:     Ira Weiny <ira.weiny@...el.com>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Catalin Marinas <catalin.marinas@....com>,
        "Matthew Wilcox (Oracle)" <willy@...radead.org>,
        Will Deacon <will@...nel.org>,
        Peter Collingbourne <pcc@...gle.com>,
        Vlastimil Babka <vbabka@...e.cz>,
        Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        linux-doc@...r.kernel.org, outreachy@...ts.linux.dev,
        Mike Rapoport <rppt@...ux.ibm.com>
Subject: Re: [PATCH 1/4] mm/highmem: Fix kernel-doc warnings in highmem*.h

On Fri, Apr 22, 2022 at 11:36:28AM +0200, Fabio M. De Francesco wrote:
> 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@...ux.ibm.com>
> > > Cc: Ira Weiny <ira.weiny@...el.com>
> > > Suggested-by: Matthew Wilcox <willy@...radead.org>
> > > Signed-off-by: Fabio M. De Francesco <fmdefrancesco@...il.com>
> > > ---
> > >  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. 

You can send a correction as an incremental patch against mmotm tree that's
mirrored here:

https://github.com/hnaz/linux-mm

I believe Andrew will add it to his mmotm queue.
 
> 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@...ux.ibm.com>
> > 
> 
> I also saw your "Acked-by" tag in patch 2/4. Thanks!
> 
> Regards,
> 
> Fabio
> 
> 

-- 
Sincerely yours,
Mike.