Re: [PATCH 15/22] mm: document maple tree pointer at unmap_vmas() at memory.c

[Liam Howlett]

* Mauro Carvalho Chehab <mchehab@xxxxxxxxxx> [220628 05:46]:
> A maple tree pointer parameter was added at unmap_vmas() without
> description:
> 
> 	mm/memory.c:1729: warning: Function parameter or member 'mt' not described in 'unmap_vmas'
> 
> Document it it.
> 
> Fixes: 5966e5c968b2 ("mm: remove the vma linked list")
> Fixes: f8acc5e9581e ("Maple Tree: add new data structure")
> Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx>
> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mchehab@xxxxxxxxxx/
> 
>  mm/memory.c | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/mm/memory.c b/mm/memory.c
> index e3d3596068f2..771b61444507 100644
> --- a/mm/memory.c
> +++ b/mm/memory.c
> @@ -1707,6 +1707,8 @@ static void unmap_single_vma(struct mmu_gather *tlb,
>  /**
>   * unmap_vmas - unmap a range of memory covered by a list of vma's
>   * @tlb: address of the caller's struct mmu_gather
> + * @mt: maple tree pointer. A maple tree is a RCU-safe range based B-tree
> + *	designed to use modern processor cache efficiently

Thanks, but I think that's a little too descriptive of type and a little
lacking of description of what this tree actually holds.

Maybe something like:
@mt: The maple tree pointer for the VMAs?

>   * @vma: the starting vma
>   * @start_addr: virtual address at which to start unmapping
>   * @end_addr: virtual address at which to end unmapping
> -- 
> 2.36.1
> 
>