[Intel-xe] [PATCH] drm/xe/uapi: Demote PMU kernel-doc to simple comment

Gustavo Sousa gustavo.sousa at intel.com
Mon Sep 18 17:24:46 UTC 2023


The current documentation in include/uapi/drm/xe_drm.h is giving the
following error:

  $ ./scripts/kernel-doc -Werror -none include/uapi/drm/xe_drm.h
  include/uapi/drm/xe_drm.h:1057: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
   * XE PMU event config IDs
  1 warnings as Errors

Turn the offending kernel-doc into a simple comment for now to unblock
CI runs. We can turn it back to a kernel-doc later once a proper fix is
in place.

Signed-off-by: Gustavo Sousa <gustavo.sousa at 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..538fdbf1e81b 100644
--- a/include/uapi/drm/xe_drm.h
+++ b/include/uapi/drm/xe_drm.h
@@ -1053,7 +1053,7 @@ struct drm_xe_vm_madvise {
 	__u64 reserved[2];
 };
 
-/**
+/*
  * XE PMU event config IDs
  *
  * Check 'man perf_event_open' to use these ID's in 'struct perf_event_attr'
-- 
2.42.0



More information about the Intel-xe mailing list