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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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 <rdunlap@xxxxxxxxxxxxx>

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

- Danilo

Cc: Dave Airlie <airlied@xxxxxxxxxx>
Cc: Danilo Krummrich <dakr@xxxxxxxxxx>
Cc: Karol Herbst <kherbst@xxxxxxxxxx>
Cc: Lyude Paul <lyude@xxxxxxxxxx>
Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
Cc: nouveau@xxxxxxxxxxxxxxxxxxxxx
Cc: Bragatheswaran Manickavel <bragathemanick0908@xxxxxxxxx>
---
v2: update commit text; somehow I sent a version of the patch before
     adding the full text.
v1: https://lore.kernel.org/lkml/20231007005518.32015-1-rdunlap@xxxxxxxxxxxxx/

  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





[Index of Archives]     [Linux DRI Users]     [Linux Intel Graphics]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [XFree86]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [XFree86]
  Powered by Linux