From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Matthew Wilcox <willy@infradead.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Andreas Gruenbacher <agruenba@redhat.com>,
Andrew Morton <akpm@linux-foundation.org>,
Guoqing Jiang <guoqing.jiang@cloud.ionos.com>,
Jens Axboe <axboe@kernel.dk>,
Johannes Weiner <hannes@cmpxchg.org>,
Stephen Rothwell <sfr@canb.auug.org.au>,
Thomas Gleixner <tglx@linutronix.de>,
William Kucharski <william.kucharski@oracle.com>,
Yang Shi <yang.shi@linux.alibaba.com>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 10/24] mm: pagemap.h: fix two kernel-doc markups
Date: Wed, 21 Oct 2020 11:55:57 +0200 [thread overview]
Message-ID: <20201021115557.24c83c35@coco.lan> (raw)
In-Reply-To: <20201013122654.GE20115@casper.infradead.org>
Hi Matthew,
Em Tue, 13 Oct 2020 13:26:54 +0100
Matthew Wilcox <willy@infradead.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@kernel.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@kernel.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@kernel.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
next prev parent reply other threads:[~2020-10-21 9:56 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-13 12:14 [PATCH v2 00/24] Documentation build fixes against next-20201013 Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 01/24] docs: hwmon: adm1266.rst: fix a broken reference Mauro Carvalho Chehab
2020-10-13 16:48 ` Guenter Roeck
2020-10-13 12:14 ` [PATCH v2 02/24] tools: docs: memory-model: fix references for some files Mauro Carvalho Chehab
2020-10-13 16:33 ` Paul E. McKenney
2020-10-13 16:38 ` Alan Stern
2020-10-14 1:58 ` Paul E. McKenney
2020-10-14 7:56 ` Mauro Carvalho Chehab
2020-10-14 14:14 ` Akira Yokosawa
2020-10-14 14:39 ` Mauro Carvalho Chehab
2020-10-14 18:57 ` Paul E. McKenney
2020-10-15 5:15 ` Mauro Carvalho Chehab
2020-10-15 10:30 ` Peter Zijlstra
2020-10-13 12:14 ` [PATCH v2 03/24] docs: SafeSetID: fix a warning Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 04/24] docs: lockdep-design: fix some warning issues Mauro Carvalho Chehab
2020-10-13 12:52 ` Peter Zijlstra
2020-10-13 13:11 ` Matthew Wilcox
2020-10-13 14:09 ` Peter Zijlstra
2020-10-13 15:02 ` Matthew Wilcox
2020-10-14 16:04 ` Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 05/24] docs: admin-guide: net.rst: add a missing blank line Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 06/24] blk-mq: docs: add kernel-doc description for a new struct member Mauro Carvalho Chehab
2020-10-13 13:29 ` John Garry
2020-10-13 19:12 ` Jens Axboe
2020-10-13 12:14 ` [PATCH v2 07/24] drm: amdgpu: kernel-doc: update some adev parameters Mauro Carvalho Chehab
2020-10-13 12:41 ` Christian König
2020-10-13 12:14 ` [PATCH v2 08/24] drm: kernel-doc: document drm_dp_set_subconnector_property() params Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 09/24] docs: kasan.rst: add two missing blank lines Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 10/24] mm: pagemap.h: fix two kernel-doc markups Mauro Carvalho Chehab
2020-10-13 12:26 ` Matthew Wilcox
2020-10-21 9:55 ` Mauro Carvalho Chehab [this message]
2020-10-21 11:28 ` Matthew Wilcox
2020-10-21 11:59 ` Mauro Carvalho Chehab
2020-10-21 12:02 ` Matthew Wilcox
2020-10-13 12:14 ` [PATCH v2 11/24] drm/dp: fix kernel-doc warnings at drm_dp_helper.c Mauro Carvalho Chehab
2020-10-13 19:20 ` Lyude Paul
2020-10-13 12:14 ` [PATCH v2 12/24] drm/dp: fix a kernel-doc issue at drm_edid.c Mauro Carvalho Chehab
2020-10-13 19:24 ` Lyude Paul
2020-10-13 19:49 ` Lyude Paul
2020-10-21 10:11 ` Mauro Carvalho Chehab
2020-10-21 16:56 ` Lyude Paul
2020-10-13 12:14 ` [PATCH v2 13/24] docs: i2c: index.rst: add slave-testunit-backend.rst Mauro Carvalho Chehab
2020-10-13 15:53 ` Wolfram Sang
2020-10-13 12:14 ` [PATCH v2 14/24] docs: conf.py: disable automarkup for Sphinx 3.x Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 15/24] docs: net: statistics.rst: remove a duplicated kernel-doc Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 16/24] seqlock: fix two kernel-doc warnings Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 17/24] docs: hwmon: mp2975.rst: address some html build warnings Mauro Carvalho Chehab
2020-10-13 16:48 ` Guenter Roeck
2020-10-13 12:14 ` [PATCH v2 18/24] docs: userspace-api: add iommu.rst to the index file Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 19/24] net: phy: remove kernel-doc duplication Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 20/24] MAINTAINERS: fix broken doc refs due to yaml conversion Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 21/24] crypto: sun8x-ce*: update entries to its documentation Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 22/24] ice: docs fix a devlink info that broke a table Mauro Carvalho Chehab
2020-10-13 22:01 ` Jacob Keller
2020-10-13 12:14 ` [PATCH v2 23/24] RDMA: add a missing kernel-doc parameter markup Mauro Carvalho Chehab
2020-10-16 16:57 ` Jason Gunthorpe
2020-10-13 12:14 ` [PATCH v2 24/24] counters: docs: add a missing include Mauro Carvalho Chehab
2020-10-15 1:06 ` Shuah Khan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201021115557.24c83c35@coco.lan \
--to=mchehab+huawei@kernel.org \
--cc=agruenba@redhat.com \
--cc=akpm@linux-foundation.org \
--cc=axboe@kernel.dk \
--cc=corbet@lwn.net \
--cc=guoqing.jiang@cloud.ionos.com \
--cc=hannes@cmpxchg.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
--cc=tglx@linutronix.de \
--cc=william.kucharski@oracle.com \
--cc=willy@infradead.org \
--cc=yang.shi@linux.alibaba.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).