[Intel-xe] [PATCH] drm/xe: Fix kernel doc warning for PMU events

[Gustavo Sousa]

Quoting Aravind Iddamsetty (2023-09-19 03:36:11-03:00)
>Add DOC keyword to PMU events comment in include/drm/xe_drm.h to make it
>kernel doc format.
>
>Fixes: 4a9681392cec ("drm/xe/pmu: Enable PMU interface")
>
>Signed-off-by: Aravind Iddamsetty <aravind.iddamsetty at linux.intel.com>
>---
> include/uapi/drm/xe_drm.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
>diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
>index 63863eda8355..6ab85c7fed36 100644
>--- a/include/uapi/drm/xe_drm.h
>+++ b/include/uapi/drm/xe_drm.h
>@@ -1054,7 +1054,7 @@ struct drm_xe_vm_madvise {
> };
> 
> /**
>- * XE PMU event config IDs
>+ * DOC: XE PMU event config IDs

That was my first thought when writing [1], but then I realized that the
XE_PMU_*() macros would not show up in the generated documentation.
Not sure if there is a special kernel-doc syntax to make them appear
there. Maybe we should just list them in this kernel-doc?

[1] https://patchwork.freedesktop.org/series/123887/

>  *
>  * Check 'man perf_event_open' to use these ID's in 'struct perf_event_attr'
>  * as part of perf_event_open syscall to read a particular event.
>-- 
>2.25.1
>