Re: [PATCH] mm/mmu_notifier: clean up mmu_notifier.h kernel-doc
From: Jason Gunthorpe
Date: Mon Mar 02 2026 - 09:26:38 EST
On Sun, Mar 01, 2026 at 04:52:22PM -0800, Randy Dunlap wrote:
> Eliminate kernel-doc warnings in mmu_notifier.h:
> - add a missing struct short description
> - use the correct format for function parameters
> - add missing function return comment sections
>
> Warning: include/linux/mmu_notifier.h:236 missing initial short
> description on line: * struct mmu_interval_notifier_ops
> Warning: include/linux/mmu_notifier.h:325 function parameter 'interval_sub'
> not described in 'mmu_interval_set_seq'
> Warning: include/linux/mmu_notifier.h:325 function parameter 'cur_seq'
> not described in 'mmu_interval_set_seq'
> Warning: include/linux/mmu_notifier.h:346 function parameter 'interval_sub'
> not described in 'mmu_interval_read_retry'
> Warning: include/linux/mmu_notifier.h:346 function parameter 'seq' not
> described in 'mmu_interval_read_retry'
> Warning: include/linux/mmu_notifier.h:346 No description found for return
> value of 'mmu_interval_read_retry'
> Warning: include/linux/mmu_notifier.h:370 function parameter 'interval_sub'
> not described in 'mmu_interval_check_retry'
> Warning: include/linux/mmu_notifier.h:370 function parameter 'seq' not
> described in 'mmu_interval_check_retry'
> Warning: include/linux/mmu_notifier.h:370 No description found for return
> value of 'mmu_interval_check_retry'
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> ---
> Cc: Jason Gunthorpe <jgg@xxxxxxxx>
> Cc: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
> Cc: linux-mm@xxxxxxxxx
>
> include/linux/mmu_notifier.h | 31 ++++++++++++++++---------------
> 1 file changed, 16 insertions(+), 15 deletions(-)
Reviewed-by: Jason Gunthorpe <jgg@xxxxxxxxxx>
Jason