[PATCH] drm/exec: Match the drm_exec_retry() kernel-doc to its parameter name

[PATCH] drm/exec: Match the drm_exec_retry() kernel-doc to its parameter name

[Karl Mehltretter]

Commit bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec
retry pointer") added drm_exec_retry() as a macro whose parameter is
_exec, with a kernel-doc that says @exec, so kernel-doc reports both an
excess and a missing parameter on every docs build.

Say @_exec.

Fixes: bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec retry pointer")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 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.53.0

Re: [PATCH] drm/exec: Match the drm_exec_retry() kernel-doc to its parameter name

[Thomas Hellström]

On Mon, 2026-09-07 at 03:11 +0200, Karl Mehltretter wrote:
> Commit bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec
> retry pointer") added drm_exec_retry() as a macro whose parameter is
> _exec, with a kernel-doc that says @exec, so kernel-doc reports both
> an
> excess and a missing parameter on every docs build.
> 
> Say @_exec.
> 
> Fixes: bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec
> retry pointer")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>

Reviewed-by: Thomas Hellström <thomas.hellstrom@linux.intel.com>

> ---
>  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.

Re: [PATCH] drm/exec: Match the drm_exec_retry() kernel-doc to its parameter name

[Christian König]

On 9/7/26 03:11, Karl Mehltretter wrote:
> Commit bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec
> retry pointer") added drm_exec_retry() as a macro whose parameter is
> _exec, with a kernel-doc that says @exec, so kernel-doc reports both an
> excess and a missing parameter on every docs build.
> 
> Say @_exec.
> 
> Fixes: bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec retry pointer")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>

I would rather rename the _exec to exec for consistency with the other macros, but either way is fine with me.

Reviewed-by: Christian König <christian.koenig@amd.com>

I assume you don't have commit rights to drm-misc-next?

Regards,
Christian.

> ---
>  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.53.0
>