linux-kernel - Re: [PATCH v2 10/24] mm: pagemap.h: fix two kernel-doc markups

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: <20201021115557.24c83c35@coco.lan>
Date:   Wed, 21 Oct 2020 11:55:57 +0200
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Matthew Wilcox <willy@...radead.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Andreas Gruenbacher <agruenba@...hat.com>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Guoqing Jiang <guoqing.jiang@...ud.ionos.com>,
        Jens Axboe <axboe@...nel.dk>,
        Johannes Weiner <hannes@...xchg.org>,
        Stephen Rothwell <sfr@...b.auug.org.au>,
        Thomas Gleixner <tglx@...utronix.de>,
        William Kucharski <william.kucharski@...cle.com>,
        Yang Shi <yang.shi@...ux.alibaba.com>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 10/24] mm: pagemap.h: fix two kernel-doc markups

Hi Matthew,

Em Tue, 13 Oct 2020 13:26:54 +0100
Matthew Wilcox <willy@...radead.org> escreveu:

> On Tue, Oct 13, 2020 at 02:14:37PM +0200, Mauro Carvalho Chehab wrote:
> > Changeset 6c8adf8446a3 ("mm: add find_lock_head") renamed the
> > index parameter, but forgot to update the kernel-doc markups
> > accordingly.  
> 
> The patch is correct (thank you!), but the description here references
> a git commit id that's only found in the -next tree and is unstable.
> 
> Andrew, can you fold this into the offending commit?

Patch already reached upstream. So, it gained a stable reference.

So, I'm changing its description to:

  Author: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
  Date:   Thu Sep 10 08:38:07 2020 +0200

    locking/refcount: move kernel-doc markups to the proper place
    
    Changeset a435b9a14356 ("locking/refcount: Provide __refcount API to obtain the old value")
    added a set of functions starting with __ that have a new
    parameter, adding a series of new warnings:
    
            $ ./scripts/kernel-doc -none include/linux/refcount.h
            include/linux/refcount.h:169: warning: Function parameter or member 'oldp' not described in '__refcount_add_not_zero'
            include/linux/refcount.h:208: warning: Function parameter or member 'oldp' not described in '__refcount_add'
            include/linux/refcount.h:239: warning: Function parameter or member 'oldp' not described in '__refcount_inc_not_zero'
            include/linux/refcount.h:261: warning: Function parameter or member 'oldp' not described in '__refcount_inc'
            include/linux/refcount.h:291: warning: Function parameter or member 'oldp' not described in '__refcount_sub_and_test'
            include/linux/refcount.h:327: warning: Function parameter or member 'oldp' not described in '__refcount_dec_and_test'
            include/linux/refcount.h:347: warning: Function parameter or member 'oldp' not described in '__refcount_dec'
    
    The issue is that the kernel-doc markups are now misplaced,
    as they should be added just before the functions.
    
    So, move the kernel-doc markups to the proper places,
    in order to drop the warnings.
    
    It should be noticed that git show produces a crappy output,
    for this patch without "--patience" flag.
    
    Fixes: a435b9a14356 ("locking/refcount: Provide __refcount API to obtain the old value")
    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

If ok for you, I should be sending it upstream on a next pull request
for the documentation warning fix series.

Regards,
Mauro

> 
> > Fixes: 6c8adf8446a3 ("mm: add find_lock_head")
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> > ---
> >  include/linux/pagemap.h | 8 ++++----
> >  1 file changed, 4 insertions(+), 4 deletions(-)
> > 
> > diff --git a/include/linux/pagemap.h b/include/linux/pagemap.h
> > index 7dd3523093db..932a260a29f2 100644
> > --- a/include/linux/pagemap.h
> > +++ b/include/linux/pagemap.h
> > @@ -342,9 +342,9 @@ static inline struct page *find_get_page_flags(struct address_space *mapping,
> >  /**
> >   * find_lock_page - locate, pin and lock a pagecache page
> >   * @mapping: the address_space to search
> > - * @offset: the page index
> > + * @index: the page index
> >   *
> > - * Looks up the page cache entry at @mapping & @offset.  If there is a
> > + * Looks up the page cache entry at @mapping & @index.  If there is a
> >   * page cache page, it is returned locked and with an increased
> >   * refcount.
> >   *
> > @@ -361,9 +361,9 @@ static inline struct page *find_lock_page(struct address_space *mapping,
> >  /**
> >   * find_lock_head - Locate, pin and lock a pagecache page.
> >   * @mapping: The address_space to search.
> > - * @offset: The page index.
> > + * @index: The page index.
> >   *
> > - * Looks up the page cache entry at @mapping & @offset.  If there is a
> > + * Looks up the page cache entry at @mapping & @index.  If there is a
> >   * page cache page, its head page is returned locked and with an increased
> >   * refcount.
> >   *
> > -- 
> > 2.26.2
> >   



Thanks,
Mauro