2023-10-08 14:02:42

by Randy Dunlap

Subject: [PATCH v2] drm/nouveau: exec: fix ioctl kernel-doc warning

kernel-doc emits a warning:

include/uapi/drm/nouveau_drm.h:49: warning: Cannot understand * @NOUVEAU_GETPARAM_EXEC_PUSH_MAX
on line 49 - I thought it was a doc line

We don't have a way to document a macro value via kernel-doc, so
change the "/**" kernel-doc marker to a C comment and format the comment
more like a kernel-doc comment for consistency.

Fixes: d59e75eef52d ("drm/nouveau: exec: report max pushs through getparam")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Dave Airlie <[email protected]>
Cc: Danilo Krummrich <[email protected]>
Cc: Karol Herbst <[email protected]>
Cc: Lyude Paul <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Bragatheswaran Manickavel <[email protected]>
---
v2: update commit text; somehow I sent a version of the patch before
adding the full text.
v1: https://lore.kernel.org/lkml/[email protected]/

include/uapi/drm/nouveau_drm.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff -- a/include/uapi/drm/nouveau_drm.h b/include/uapi/drm/nouveau_drm.h
--- a/include/uapi/drm/nouveau_drm.h
+++ b/include/uapi/drm/nouveau_drm.h
@@ -45,8 +45,8 @@ extern "C" {
#define NOUVEAU_GETPARAM_HAS_BO_USAGE 15
#define NOUVEAU_GETPARAM_HAS_PAGEFLIP 16

-/**
- * @NOUVEAU_GETPARAM_EXEC_PUSH_MAX
+/*
+ * NOUVEAU_GETPARAM_EXEC_PUSH_MAX - query max pushes through getparam
*
* Query the maximum amount of IBs that can be pushed through a single
* &drm_nouveau_exec structure and hence a single &DRM_IOCTL_NOUVEAU_EXEC

2023-10-09 21:38:16

by Lyude Paul

Subject: Re: [PATCH v2] drm/nouveau: exec: fix ioctl kernel-doc warning

Reviewed-by: Lyude Paul <[email protected]>

On Sun, 2023-10-08 at 07:02 -0700, Randy Dunlap wrote:
> kernel-doc emits a warning:
>
> include/uapi/drm/nouveau_drm.h:49: warning: Cannot understand * @NOUVEAU_GETPARAM_EXEC_PUSH_MAX
> on line 49 - I thought it was a doc line
>
> We don't have a way to document a macro value via kernel-doc, so
> change the "/**" kernel-doc marker to a C comment and format the comment
> more like a kernel-doc comment for consistency.
>
> Fixes: d59e75eef52d ("drm/nouveau: exec: report max pushs through getparam")
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Dave Airlie <[email protected]>
> Cc: Danilo Krummrich <[email protected]>
> Cc: Karol Herbst <[email protected]>
> Cc: Lyude Paul <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: Bragatheswaran Manickavel <[email protected]>
> ---
> v2: update commit text; somehow I sent a version of the patch before
> adding the full text.
> v1: https://lore.kernel.org/lkml/[email protected]/
>
> include/uapi/drm/nouveau_drm.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff -- a/include/uapi/drm/nouveau_drm.h b/include/uapi/drm/nouveau_drm.h
> --- a/include/uapi/drm/nouveau_drm.h
> +++ b/include/uapi/drm/nouveau_drm.h
> @@ -45,8 +45,8 @@ extern "C" {
> #define NOUVEAU_GETPARAM_HAS_BO_USAGE 15
> #define NOUVEAU_GETPARAM_HAS_PAGEFLIP 16
>
> -/**
> - * @NOUVEAU_GETPARAM_EXEC_PUSH_MAX
> +/*
> + * NOUVEAU_GETPARAM_EXEC_PUSH_MAX - query max pushes through getparam
> *
> * Query the maximum amount of IBs that can be pushed through a single
> * &drm_nouveau_exec structure and hence a single &DRM_IOCTL_NOUVEAU_EXEC
>

--
Cheers,
Lyude Paul (she/her)
Software Engineer at Red Hat

2023-10-12 17:55:11

by Danilo Krummrich

Subject: Re: [PATCH v2] drm/nouveau: exec: fix ioctl kernel-doc warning

On 10/8/23 16:02, Randy Dunlap wrote:
> kernel-doc emits a warning:
>
> include/uapi/drm/nouveau_drm.h:49: warning: Cannot understand * @NOUVEAU_GETPARAM_EXEC_PUSH_MAX
> on line 49 - I thought it was a doc line
>
> We don't have a way to document a macro value via kernel-doc, so
> change the "/**" kernel-doc marker to a C comment and format the comment
> more like a kernel-doc comment for consistency.
>
> Fixes: d59e75eef52d ("drm/nouveau: exec: report max pushs through getparam")
> Signed-off-by: Randy Dunlap <[email protected]>

Thanks for fixing this up, applied to drm-misc-fixes.

- Danilo

> Cc: Dave Airlie <[email protected]>
> Cc: Danilo Krummrich <[email protected]>
> Cc: Karol Herbst <[email protected]>
> Cc: Lyude Paul <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: Bragatheswaran Manickavel <[email protected]>
> ---
> v2: update commit text; somehow I sent a version of the patch before
> adding the full text.
> v1: https://lore.kernel.org/lkml/[email protected]/
>
> include/uapi/drm/nouveau_drm.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff -- a/include/uapi/drm/nouveau_drm.h b/include/uapi/drm/nouveau_drm.h
> --- a/include/uapi/drm/nouveau_drm.h
> +++ b/include/uapi/drm/nouveau_drm.h
> @@ -45,8 +45,8 @@ extern "C" {
> #define NOUVEAU_GETPARAM_HAS_BO_USAGE 15
> #define NOUVEAU_GETPARAM_HAS_PAGEFLIP 16
>
> -/**
> - * @NOUVEAU_GETPARAM_EXEC_PUSH_MAX
> +/*
> + * NOUVEAU_GETPARAM_EXEC_PUSH_MAX - query max pushes through getparam
> *
> * Query the maximum amount of IBs that can be pushed through a single
> * &drm_nouveau_exec structure and hence a single &DRM_IOCTL_NOUVEAU_EXEC
>