From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 7BA97C27C4F for ; Fri, 21 Jun 2024 21:39:46 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 0F95610E166; Fri, 21 Jun 2024 21:39:46 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=intel.com header.i=@intel.com header.b="T7NVSlhG"; dkim-atps=neutral Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.7]) by gabe.freedesktop.org (Postfix) with ESMTPS id C314610E166 for ; Fri, 21 Jun 2024 21:39:44 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1719005985; x=1750541985; h=date:message-id:from:to:cc:subject:in-reply-to: references:mime-version; bh=0G3GnwS5ikoZill3mlMoHKNNbqjyZSyfYTbbgyGzqDA=; b=T7NVSlhG8ZPeScAdK44FrQ9U3TY4vJXl8AuM1AuasltCgcsWXdzeNtXr XTLItHSiCmE1tnVkXcIs6UqDU2q1ZPKkjxNLFGCt6BbbOQ3Hxy0d0c5WF bhrysrDaeU1LKQyOyI8OUkvPMo8FgpsAsx8E61hxZPbXJRrOxWdEoAel+ b6BgePNeTJaF2GfuVtvMYrhO9HYlK500g3RVpStMMPHFGovic08tXO6zp og+hQ1wZSYuIpJ8NnVYoERCm9lb1UzlSKox7KHyofPIQJ+4BHMcJ4nkI/ dnoLZDTEJN+X1GVPOn6dbeNKbqlTRxTkL7bogncrPZMymiVbRV1X6uxo2 w==; X-CSE-ConnectionGUID: aSZQqnCxSxSu3zyiHL5ZlA== X-CSE-MsgGUID: zKQEoZcHRLqWyCVZcf5GRA== X-IronPort-AV: E=McAfee;i="6700,10204,11110"; a="41463161" X-IronPort-AV: E=Sophos;i="6.08,255,1712646000"; d="scan'208";a="41463161" Received: from fmviesa003.fm.intel.com ([10.60.135.143]) by fmvoesa101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Jun 2024 14:39:44 -0700 X-CSE-ConnectionGUID: HdYZyVG3QX2SzbwiQRBTYg== X-CSE-MsgGUID: 3F6WMndpS9+FQyNS4prvtg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.08,255,1712646000"; d="scan'208";a="47069890" Received: from vishrutm-mobl11.amr.corp.intel.com (HELO adixit-arch.intel.com) ([10.125.97.201]) by fmviesa003-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Jun 2024 14:39:43 -0700 Date: Fri, 21 Jun 2024 14:36:03 -0700 Message-ID: <87wmmihtbw.wl-ashutosh.dixit@intel.com> From: "Dixit, Ashutosh" To: Michal Wajdeczko Cc: , Umesh Nerlige Ramappa Subject: Re: [PATCH] drm/xe/oa: Fix 'enum drm_xe_perf_type' kernel doc warnings In-Reply-To: <508be309-17c8-419a-92b4-91cd06d2cb6b@intel.com> References: <20240621190903.3593781-1-ashutosh.dixit@intel.com> <508be309-17c8-419a-92b4-91cd06d2cb6b@intel.com> User-Agent: Wanderlust/2.15.9 (Almost Unreal) SEMI-EPG/1.14.7 (Harue) FLIM-LB/1.14.9 (=?ISO-8859-4?Q?Goj=F2?=) APEL-LB/10.8 EasyPG/1.0.0 Emacs/29.3 (x86_64-pc-linux-gnu) MULE/6.0 (HANACHIRUSATO) MIME-Version: 1.0 (generated by SEMI-EPG 1.14.7 - "Harue") Content-Type: text/plain; charset=US-ASCII X-BeenThere: intel-xe@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Intel Xe graphics driver List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: intel-xe-bounces@lists.freedesktop.org Sender: "Intel-xe" On Fri, 21 Jun 2024 12:45:43 -0700, Michal Wajdeczko wrote: > Hi Michal, > > On 21.06.2024 21:09, Ashutosh Dixit wrote: > > Include kernel doc's for 'enum drm_xe_perf_type' to fix kernel doc > > warnings. > > > > Reported-by: Michal Wajdeczko > > Signed-off-by: Ashutosh Dixit > > --- > > include/uapi/drm/xe_drm.h | 5 ++++- > > 1 file changed, 4 insertions(+), 1 deletion(-) > > > > diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h > > index 93e00be44b2d..d831f277f186 100644 > > --- a/include/uapi/drm/xe_drm.h > > +++ b/include/uapi/drm/xe_drm.h > > @@ -1379,8 +1379,11 @@ struct drm_xe_wait_user_fence { > > * enum drm_xe_perf_type - Perf stream types > > */ > > enum drm_xe_perf_type { > > + /** @DRM_XE_PERF_TYPE_OA: OA perf stream type */ > > DRM_XE_PERF_TYPE_OA, > > - __DRM_XE_PERF_TYPE_MAX, /* non-ABI */ > > + > > + /** @__DRM_XE_PERF_TYPE_MAX: Non-ABI */ > > hmm, I would rather not document it at all, by marking it as: > > /* private: */ > > see https://www.kernel.org/doc/html/next/doc-guide/kernel-doc.html#members > > > + __DRM_XE_PERF_TYPE_MAX, > > }; > > > > /** Unfortunately, not documenting it doesn't seem to work and will result in kernel-doc error below: $ ./scripts/kernel-doc -Werror -none include/uapi/drm/xe_drm.h include/uapi/drm/xe_drm.h:1388: warning: Enum value '__DRM_XE_PERF_TYPE_MAX' not described in enum 'drm_xe_perf_type' 1 warnings as Errors Thanks. -- Ashutosh