Received-SPF: pass (google.com: domain of linux-kernel+bounces-11589-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Date: Tue, 26 Dec 2023 12:05:51 -0500
From: Rodrigo Vivi <rodrigo.vivi@intel.com>
To: Randy Dunlap <rdunlap@infradead.org>
CC: <linux-kernel@vger.kernel.org>, Jonathan Corbet <corbet@lwn.net>,
	<intel-gfx@lists.freedesktop.org>, <dri-devel@lists.freedesktop.org>
Subject: Re: [PATCH 4/4] drm/i915/perf: reconcile Excess struct member
 kernel-doc warnings
Message-ID: <ZYsH757tT6sdSjDI@intel.com>
References: <20231221032029.30942-1-rdunlap@infradead.org>
 <20231221032029.30942-4-rdunlap@infradead.org>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20231221032029.30942-4-rdunlap@infradead.org>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?dMdy5sGhpzE2LyRdwS1hzBS0nfw8l+2A7L2lbmqJuwekEz19ZPgOnGH94Gxg?=
 =?us-ascii?Q?ifsmvj1uMpfP/eQx5j4Ycq99yB01Duo1+OVBI+mD+KpDFIVFV8ht7NJUyn/+?=
 =?us-ascii?Q?HgZ0eSAaiA7KYNhJNyqW0Ov3acGl+L5vO/zOtFFkH6saVWn97jYwRPc66aaU?=
 =?us-ascii?Q?RxPk9g5iObz9QcfCnlLbkyjjtOXzps4ODMz+5gIyzHB/svEb5Dc2kTI+o6SP?=
 =?us-ascii?Q?3VYfMADESnAsiBhiuNBSXN//gH9k9uqiByx08FVKSuUrex3K7R8PSWcM0xq4?=
 =?us-ascii?Q?i6saafBjwhPQHPyb5K17sEU1Y+KlOGkdAPYMoibBO1CJmIlL6exx+RAbe/tE?=
 =?us-ascii?Q?p/4QnIIJIvdJtqSLfCih39R8eqAQXOyMD85FJNt8g4Zz+ONevW2FKH8bjjOg?=
 =?us-ascii?Q?Zi+X3JBA/7pAtRhvarit2fKF2FJ/o9KHgH9kqaiuvKHwYAbXQq/Vr467FbrP?=
 =?us-ascii?Q?WBbjQMJhkfpF9BatQm9fQxavHwThU2CSL8agFMqBBZTM7AeOCkKid57L0qdE?=
 =?us-ascii?Q?i89nZq07GklKU+dmayBR3TvQOdl/OFrOyrTFkwugkJ1h/QsOrLrcETrX/UrP?=
 =?us-ascii?Q?r45lnylv6CHqIYYz1QscYBSxHey/sqSkTGURj5K45bx44xEsBR7dTe+hKjuo?=
 =?us-ascii?Q?S8OJ+DXoXjbj4Bd2UPOMimT/bhTrmwlt98oYTDIdmsDggUvfybUTL2BndVVy?=
 =?us-ascii?Q?xYznd90mGKyFOyI31MY+kFfnvoz5R7KQOdKvofhZxOWvgYCFT0yQaeOcqow+?=
 =?us-ascii?Q?rL1/1+EDiiB0RoR8uNImkRyULas6+qyQuVrfEet4Bx7Ef2TNBXwuq2LL+umk?=
 =?us-ascii?Q?EHdX22MpIGcpE1Wp/jhvMEoBxh45w4LRKhaoVGfFNsG6915GSBrM+4MoEQrg?=
 =?us-ascii?Q?2hDir3oEAw5llbAXC23rwwwx6wbg8ThzxUgi2PzZuXZZvBvaksRTj5ZBKbuV?=
 =?us-ascii?Q?u6eWlyWSnS47GhSzDmN+QkRibD+Ljb0YHW8w7aUeNktl/1IxWmJo4ZPbpV2O?=
 =?us-ascii?Q?q4G564vRrarNNg2Ij1aiz3IWZ50rfrKvCaA8osAzOytcBH1NHZMzqmePIysL?=
 =?us-ascii?Q?XWLq83dPCsWvj74gmto0t0JCJ3MvIzUt7VC+CACVHNCoXzOU+iqly/h3gKpI?=
 =?us-ascii?Q?Y5M932Rjao+QVJbKE3VsclMMw+mOS9YK2rfS8r++EXPWuY+Jl4osm9Ch0DMA?=
 =?us-ascii?Q?+see15eMd6F99p/baV+PpqDu0Q9wOKd3sxJbCDFvIBfhMKALOCGZrSN7/meg?=
 =?us-ascii?Q?WFulnZS0uSrKyi4EBuyIRBs0lRGRdWd4b9g812x/6zsPUtlmS6/onsmZVgdj?=
 =?us-ascii?Q?uyoOxA/RgMf8EAtnS9MDEfXCn83I5R9+6oU9H11r/LvfFF1cyjpBtUBG4lhw?=
 =?us-ascii?Q?aSTvSk82RmNmgov2cvQdftA4OSYLi1cWIQm5vcZzjcFKlTuq7sk4bppJsdA8?=
 =?us-ascii?Q?0b+PePHVS+xBrAlmqsRmOh4SkB37MspQ1XPO9hC+Z+rhoRO+5jym7t1Q7klt?=
 =?us-ascii?Q?805z3siF2FH0LYJvpRe4eZZvQccYfky/SspCxGftKil/drwwC2/Jz8BMWcDI?=
 =?us-ascii?Q?m4IHzVzAbFMiy1NSyjJCn2wZnR0O3eE1MDXd+vWm?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 75f5ae2c-fb94-4b01-c8b0-08dc0634ec3e
X-MS-Exchange-CrossTenant-AuthSource: MN0PR11MB6059.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 26 Dec 2023 17:05:55.3791
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: fx9kqowg7nI0yFLB+WUduft5cqJApC77fA3cTjsNNBp++aGUfzYr+bTDhgMYzXszKG/UhhhwYFKtNKCsanjDlg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LV8PR11MB8584
X-OriginatorOrg: intel.com

On Wed, Dec 20, 2023 at 07:20:29PM -0800, Randy Dunlap wrote:
> 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


for the series:
Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

I'm afraid patchwork was down when you sent this out.
Could you please rebase and resend? Just to ensure
our CI doesn't complain and then we push it.

Thanks,
Rodrigo.

> ---
>  drivers/gpu/drm/i915/i915_perf_types.h |    9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff -- a/drivers/gpu/drm/i915/i915_perf_types.h b/drivers/gpu/drm/i915/i915_perf_types.h
> --- a/drivers/gpu/drm/i915/i915_perf_types.h
> +++ b/drivers/gpu/drm/i915/i915_perf_types.h
> @@ -291,7 +291,8 @@ struct i915_perf_stream {
>  		int size_exponent;
>  
>  		/**
> -		 * @ptr_lock: Locks reads and writes to all head/tail state
> +		 * @oa_buffer.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
> @@ -313,7 +314,8 @@ struct i915_perf_stream {
>  		spinlock_t ptr_lock;
>  
>  		/**
> -		 * @head: Although we can always read back the head pointer register,
> +		 * @oa_buffer.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
> @@ -322,7 +324,8 @@ struct i915_perf_stream {
>  		u32 head;
>  
>  		/**
> -		 * @tail: The last verified tail that can be read by userspace.
> +		 * @oa_buffer.tail: The last verified tail that can be
> +		 * read by userspace.
>  		 */
>  		u32 tail;
>  	} oa_buffer;