[Intel-gfx] [PATCH] drm/i915/perf: Fix use of kernel-doc format in structure members.

[Lionel Landwerlin]

On 20/09/2019 12:47, Anna Karas wrote:
> Insert structure members names into their descriptions to follow
> kernel-doc format.
>
> Reviewed-by: Chris Wilson <chris at chris-wilson.co.uk>
> Signed-off-by: Anna Karas <anna.karas at intel.com>

Acked-by: Lionel Landwerlin <lionel.g.landwerlin at intel.com>


> ---
>   drivers/gpu/drm/i915/i915_drv.h | 26 ++++++++++++++------------
>   1 file changed, 14 insertions(+), 12 deletions(-)
>
> diff --git a/drivers/gpu/drm/i915/i915_drv.h b/drivers/gpu/drm/i915/i915_drv.h
> index 0d1949a78c44..dc6c9f52d3a5 100644
> --- a/drivers/gpu/drm/i915/i915_drv.h
> +++ b/drivers/gpu/drm/i915/i915_drv.h
> @@ -1225,7 +1225,7 @@ struct i915_perf_stream {
>   	struct i915_oa_config *oa_config;
>   
>   	/**
> -	 * The OA context specific information.
> +	 * @pinned_ctx: The OA context specific information.
>   	 */
>   	struct intel_context *pinned_ctx;
>   	u32 specific_ctx_id;
> @@ -1239,7 +1239,7 @@ struct i915_perf_stream {
>   	int period_exponent;
>   
>   	/**
> -	 * State of the OA buffer.
> +	 * @oa_buffer: State of the OA buffer.
>   	 */
>   	struct {
>   		struct i915_vma *vma;
> @@ -1250,7 +1250,7 @@ struct i915_perf_stream {
>   		int size_exponent;
>   
>   		/**
> -		 * Locks reads and writes to all head/tail state
> +		 * @ptr_lock: Locks reads and writes to all head/tail state
>   		 *
>   		 * Consider: the head and tail pointer state needs to be read
>   		 * consistently from a hrtimer callback (atomic context) and
> @@ -1272,8 +1272,8 @@ struct i915_perf_stream {
>   		spinlock_t ptr_lock;
>   
>   		/**
> -		 * One 'aging' tail pointer and one 'aged' tail pointer ready to
> -		 * used for reading.
> +		 * @tails: One 'aging' tail pointer and one 'aged' tail pointer
> +		 * ready to used for reading.
>   		 *
>   		 * Initial values of 0xffffffff are invalid and imply that an
>   		 * update is required (and should be ignored by an attempted
> @@ -1284,21 +1284,23 @@ struct i915_perf_stream {
>   		} tails[2];
>   
>   		/**
> -		 * Index for the aged tail ready to read() data up to.
> +		 * @aged_tail_idx: Index for the aged tail ready to read() data
> +		 * up to.
>   		 */
>   		unsigned int aged_tail_idx;
>   
>   		/**
> -		 * A monotonic timestamp for when the current aging tail pointer
> -		 * was read; used to determine when it is old enough to trust.
> +		 * @aging_timestamp: A monotonic timestamp for when the current
> +		 * aging tail pointer was read; used to determine when it is old
> +		 * enough to trust.
>   		 */
>   		u64 aging_timestamp;
>   
>   		/**
> -		 * Although we can always read back the head pointer register,
> -		 * we prefer to avoid trusting the HW state, just to avoid any
> -		 * risk that some hardware condition could * somehow bump the
> -		 * head pointer unpredictably and cause us to forward the wrong
> +		 * @head: Although we can always read back the head pointer
> +		 * register, we prefer to avoid trusting the HW state, just to
> +		 * avoid any risk that some hardware condition could somehow bump
> +		 * the head pointer unpredictably and cause us to forward the wrong
>   		 * OA buffer data to userspace.
>   		 */
>   		u32 head;