2023-10-06 11:40:22

by Muhammad Muzammil

[permalink] [raw]
Subject: [PATCH] mm: rmap.c: fix kenrel-doc warning

From: Muhammad Muzammil <[email protected]>

after running make htmldocs, getting this warning
warning: Function parameter or member 'folio' not described in
'folio_move_anon_rmap'
and this patch resolves this warning

Signed-off-by: Muhammad Muzammil <[email protected]>
---
mm/rmap.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mm/rmap.c b/mm/rmap.c
index c1f11c9dbe61..0863083b3472 100644
--- a/mm/rmap.c
+++ b/mm/rmap.c
@@ -1129,7 +1129,7 @@ int folio_total_mapcount(struct folio *folio)

/**
* folio_move_anon_rmap - move a folio to our anon_vma
- * @page: The folio to move to our anon_vma
+ * @folio: struct folio - Represents a contiguous set of bytes.
* @vma: The vma the folio belongs to
*
* When a folio belongs exclusively to one process after a COW event,
--
2.27.0


2023-10-06 12:17:06

by Matthew Wilcox

[permalink] [raw]
Subject: Re: [PATCH] mm: rmap.c: fix kenrel-doc warning

On Fri, Oct 06, 2023 at 04:39:48PM +0500, Muzammil wrote:
> /**
> * folio_move_anon_rmap - move a folio to our anon_vma
> - * @page: The folio to move to our anon_vma
> + * @folio: struct folio - Represents a contiguous set of bytes.
> * @vma: The vma the folio belongs to

Why did you change more than just 'page' to 'folio'? I think the
other changes you have made to this line are not an improvement.

2023-10-06 12:18:33

by David Hildenbrand

[permalink] [raw]
Subject: Re: [PATCH] mm: rmap.c: fix kenrel-doc warning

On 06.10.23 13:39, Muzammil wrote:
> From: Muhammad Muzammil <[email protected]>
>
> after running make htmldocs, getting this warning
> warning: Function parameter or member 'folio' not described in
> 'folio_move_anon_rmap'
> and this patch resolves this warning
>
> Signed-off-by: Muhammad Muzammil <[email protected]>
> ---
> mm/rmap.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/mm/rmap.c b/mm/rmap.c
> index c1f11c9dbe61..0863083b3472 100644
> --- a/mm/rmap.c
> +++ b/mm/rmap.c
> @@ -1129,7 +1129,7 @@ int folio_total_mapcount(struct folio *folio)
>
> /**
> * folio_move_anon_rmap - move a folio to our anon_vma
> - * @page: The folio to move to our anon_vma
> + * @folio: struct folio - Represents a contiguous set of bytes.
> * @vma: The vma the folio belongs to
> *
> * When a folio belongs exclusively to one process after a COW event,

Thanks for taking care of that, I had to handle a family NMI the last
couple of days.

That should be squashed into my commit.

--
Cheers,

David / dhildenb

2023-10-06 12:19:30

by David Hildenbrand

[permalink] [raw]
Subject: Re: [PATCH] mm: rmap.c: fix kenrel-doc warning

On 06.10.23 14:16, Matthew Wilcox wrote:
> On Fri, Oct 06, 2023 at 04:39:48PM +0500, Muzammil wrote:
>> /**
>> * folio_move_anon_rmap - move a folio to our anon_vma
>> - * @page: The folio to move to our anon_vma
>> + * @folio: struct folio - Represents a contiguous set of bytes.
>> * @vma: The vma the folio belongs to
>
> Why did you change more than just 'page' to 'folio'? I think the
> other changes you have made to this line are not an improvement.

Oh, I missed that. indeed, just s/page/folio/ is sufficient.

--
Cheers,

David / dhildenb