| Message ID | 20231008140231.17921-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v2] drm/nouveau: exec: fix ioctl kernel-doc warning | expand |
Reviewed-by: Lyude Paul <lyude@redhat.com> 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 <rdunlap@infradead.org> > Cc: Dave Airlie <airlied@redhat.com> > Cc: Danilo Krummrich <dakr@redhat.com> > Cc: Karol Herbst <kherbst@redhat.com> > Cc: Lyude Paul <lyude@redhat.com> > Cc: dri-devel@lists.freedesktop.org > Cc: nouveau@lists.freedesktop.org > Cc: Bragatheswaran Manickavel <bragathemanick0908@gmail.com> > --- > 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@infradead.org/ > > 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 >
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@infradead.org> Thanks for fixing this up, applied to drm-misc-fixes. - Danilo > Cc: Dave Airlie <airlied@redhat.com> > Cc: Danilo Krummrich <dakr@redhat.com> > Cc: Karol Herbst <kherbst@redhat.com> > Cc: Lyude Paul <lyude@redhat.com> > Cc: dri-devel@lists.freedesktop.org > Cc: nouveau@lists.freedesktop.org > Cc: Bragatheswaran Manickavel <bragathemanick0908@gmail.com> > --- > 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@infradead.org/ > > 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 >
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
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@infradead.org> Cc: Dave Airlie <airlied@redhat.com> Cc: Danilo Krummrich <dakr@redhat.com> Cc: Karol Herbst <kherbst@redhat.com> Cc: Lyude Paul <lyude@redhat.com> Cc: dri-devel@lists.freedesktop.org Cc: nouveau@lists.freedesktop.org Cc: Bragatheswaran Manickavel <bragathemanick0908@gmail.com> --- 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@infradead.org/ include/uapi/drm/nouveau_drm.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)