Re: (subset) [PATCH] drm/gpuvm: fix all kernel-doc warnings in include/drm/drm_gpuvm.h

[Maxime Ripard]

On Sat, 30 Dec 2023 21:48:56 -0800, Randy Dunlap wrote:
> Update kernel-doc comments in <drm/drm_gpuvm.h> to correct all
> kernel-doc warnings:
> 
> drm_gpuvm.h:148: warning: Excess struct member 'addr' description in 'drm_gpuva'
> drm_gpuvm.h:148: warning: Excess struct member 'offset' description in 'drm_gpuva'
> drm_gpuvm.h:148: warning: Excess struct member 'obj' description in 'drm_gpuva'
> drm_gpuvm.h:148: warning: Excess struct member 'entry' description in 'drm_gpuva'
> drm_gpuvm.h:148: warning: Excess struct member '__subtree_last' description in 'drm_gpuva'
> drm_gpuvm.h:192: warning: No description found for return value of 'drm_gpuva_invalidated'
> drm_gpuvm.h:331: warning: Excess struct member 'tree' description in 'drm_gpuvm'
> drm_gpuvm.h:331: warning: Excess struct member 'list' description in 'drm_gpuvm'
> drm_gpuvm.h:331: warning: Excess struct member 'list' description in 'drm_gpuvm'
> drm_gpuvm.h:331: warning: Excess struct member 'local_list' description in 'drm_gpuvm'
> drm_gpuvm.h:331: warning: Excess struct member 'lock' description in 'drm_gpuvm'
> drm_gpuvm.h:331: warning: Excess struct member 'list' description in 'drm_gpuvm'
> drm_gpuvm.h:331: warning: Excess struct member 'local_list' description in 'drm_gpuvm'
> drm_gpuvm.h:331: warning: Excess struct member 'lock' description in 'drm_gpuvm'
> drm_gpuvm.h:352: warning: No description found for return value of 'drm_gpuvm_get'
> drm_gpuvm.h:545: warning: Excess struct member 'fn' description in 'drm_gpuvm_exec'
> drm_gpuvm.h:545: warning: Excess struct member 'priv' description in 'drm_gpuvm_exec'
> drm_gpuvm.h:597: warning: missing initial short description on line:
>  * drm_gpuvm_exec_resv_add_fence()
> drm_gpuvm.h:616: warning: missing initial short description on line:
>  * drm_gpuvm_exec_validate()
> drm_gpuvm.h:623: warning: No description found for return value of 'drm_gpuvm_exec_validate'
> drm_gpuvm.h:698: warning: Excess struct member 'gpuva' description in 'drm_gpuvm_bo'
> drm_gpuvm.h:698: warning: Excess struct member 'entry' description in 'drm_gpuvm_bo'
> drm_gpuvm.h:698: warning: Excess struct member 'gem' description in 'drm_gpuvm_bo'
> drm_gpuvm.h:698: warning: Excess struct member 'evict' description in 'drm_gpuvm_bo'
> drm_gpuvm.h:726: warning: No description found for return value of 'drm_gpuvm_bo_get'
> drm_gpuvm.h:738: warning: missing initial short description on line:
>  * drm_gpuvm_bo_gem_evict()
> drm_gpuvm.h:740: warning: missing initial short description on line:
>  * drm_gpuvm_bo_gem_evict()
> drm_gpuvm.h:698: warning: Excess struct member 'evict' description in 'drm_gpuvm_bo'
> drm_gpuvm.h:844: warning: Excess struct member 'addr' description in 'drm_gpuva_op_map'
> drm_gpuvm.h:844: warning: Excess struct member 'range' description in 'drm_gpuva_op_map'
> drm_gpuvm.h:844: warning: Excess struct member 'offset' description in 'drm_gpuva_op_map'
> drm_gpuvm.h:844: warning: Excess struct member 'obj' description in 'drm_gpuva_op_map'
> 
> [...]

Applied to drm/drm-misc (drm-misc-next-fixes).

Thanks!
Maxime