2023-10-06 12:28:52

by Muhammad Muzammil

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

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

changes since v1:
- changed page to folio and reverted other changes

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..6976fb6feeed 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: The folio to move to our anon_vma
* @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:55:02

by David Hildenbrand

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

On 06.10.23 14:28, Muhammad Muzammil wrote:
> 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
>
> changes since v1:
> - changed page to folio and reverted other changes
>
> 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..6976fb6feeed 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: The folio to move to our anon_vma
> * @vma: The vma the folio belongs to
> *
> * When a folio belongs exclusively to one process after a COW event,

Reviewed-by: David Hildenbrand <[email protected]>

--
Cheers,

David / dhildenb