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

From: Matthew Wilcox
Date: Tue Oct 13 2020 - 08:27:00 EST


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?

> Fixes: 6c8adf8446a3 ("mm: add find_lock_head")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> ---
> 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
>