Skip to content

Commit d505a16

Browse files
rddunlapjlahtine-intel
authored andcommitted
drm/i915/perf: reconcile Excess struct member kernel-doc warnings
Document nested struct members with full names as described in Documentation/doc-guide/kernel-doc.rst. i915_perf_types.h:341: warning: Excess struct member 'ptr_lock' description in 'i915_perf_stream' i915_perf_types.h:341: warning: Excess struct member 'head' description in 'i915_perf_stream' i915_perf_types.h:341: warning: Excess struct member 'tail' description in 'i915_perf_stream' 3 warnings as Errors Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jani Nikula <jani.nikula@linux.intel.com> Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com> Cc: Rodrigo Vivi <rodrigo.vivi@intel.com> Cc: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com> Cc: intel-gfx@lists.freedesktop.org Cc: Jonathan Corbet <corbet@lwn.net> Cc: dri-devel@lists.freedesktop.org Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com> Reviewed-by: Andi Shyti <andi.shyti@linux.intel.com> Signed-off-by: Andi Shyti <andi.shyti@linux.intel.com> Link: https://patchwork.freedesktop.org/patch/msgid/20231226195432.10891-4-rdunlap@infradead.org (cherry picked from commit aa253ba) Signed-off-by: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
1 parent af3cfca commit d505a16

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

drivers/gpu/drm/i915/i915_perf_types.h

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,8 @@ struct i915_perf_stream {
291291
int size_exponent;
292292

293293
/**
294-
* @ptr_lock: Locks reads and writes to all head/tail state
294+
* @oa_buffer.ptr_lock: Locks reads and writes to all
295+
* head/tail state
295296
*
296297
* Consider: the head and tail pointer state needs to be read
297298
* consistently from a hrtimer callback (atomic context) and
@@ -313,7 +314,8 @@ struct i915_perf_stream {
313314
spinlock_t ptr_lock;
314315

315316
/**
316-
* @head: Although we can always read back the head pointer register,
317+
* @oa_buffer.head: Although we can always read back
318+
* the head pointer register,
317319
* we prefer to avoid trusting the HW state, just to avoid any
318320
* risk that some hardware condition could * somehow bump the
319321
* head pointer unpredictably and cause us to forward the wrong
@@ -322,7 +324,8 @@ struct i915_perf_stream {
322324
u32 head;
323325

324326
/**
325-
* @tail: The last verified tail that can be read by userspace.
327+
* @oa_buffer.tail: The last verified tail that can be
328+
* read by userspace.
326329
*/
327330
u32 tail;
328331
} oa_buffer;

0 commit comments

Comments
 (0)