When running 'make htmldocs', Sphinx complains: WARNING: ./include/drm/drm_exec.h:162 function parameter '_exec' not described in 'drm_exec_retry' WARNING: ./include/drm/drm_exec.h:162 Excess function parameter 'exec' description in 'drm_exec_retry' (did you mean one of: '_exec') WARNING: ./include/drm/drm_exec.h:162 function parameter '_exec' not described in 'drm_exec_retry' WARNING: ./include/drm/drm_exec.h:162 Excess function parameter 'exec' description in 'drm_exec_retry' (did you mean one of: '_exec')
If duplicate, please ignore. Thanks. -- >8 -- From: Weijie Yuan <[email protected]> drm_exec_retry() takes _exec, but its kernel-doc describes exec. This produces missing and excess parameter description warnings. Use the macro parameter's actual name in the comment. Fixes: bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec retry pointer") Signed-off-by: Weijie Yuan <[email protected]> --- include/drm/drm_exec.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/drm/drm_exec.h b/include/drm/drm_exec.h index c92d69a2c793..5a2a8438f094 100644 --- a/include/drm/drm_exec.h +++ b/include/drm/drm_exec.h @@ -153,7 +153,7 @@ static inline bool drm_exec_is_contended(struct drm_exec *exec) /** * drm_exec_retry() - Unconditionally restart the loop to grab all locks. - * @exec: drm_exec object + * @_exec: drm_exec object * * Unconditionally retry the loop to lock all objects. For consistency, * the exec object needs to be newly initialized. -- 2.56.0.438.g30c3f27cb8
