Building the documentation currently with make htmldocs gives the
following errors:
WARNING: ./include/drm/drm_exec.h:159 function parameter '_exec' not
described in 'drm_exec_retry'
WARNING: ./include/drm/drm_exec.h:159 Excess function parameter 'exec'
description in 'drm_exec_retry' (did you mean one of: '_exec')
WARNING: ./include/drm/drm_exec.h:159 function parameter '_exec' not
described in 'drm_exec_retry'
WARNING: ./include/drm/drm_exec.h:159 Excess function parameter 'exec'
description in 'drm_exec_retry' (did you mean one of: '_exec')
This is because the parameter is defined without the underscore in the
kernel-doc string. Change the parameter name to add the missing
underscore.
Fixes: bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec retry
pointer")
Signed-off-by: Jakov Novak <[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 cc2937185a9f..ae1d074ade5a 100644
--- a/include/drm/drm_exec.h
+++ b/include/drm/drm_exec.h
@@ -150,7 +150,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
