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 C3D6EC27C53 for ; Sat, 22 Jun 2024 16:03:05 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 607D410E28B; Sat, 22 Jun 2024 16:03:05 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=intel.com header.i=@intel.com header.b="dyk5p8iW"; dkim-atps=neutral Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.12]) by gabe.freedesktop.org (Postfix) with ESMTPS id C405310E28B for ; Sat, 22 Jun 2024 16:03:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1719072184; x=1750608184; h=date:message-id:from:to:cc:subject:in-reply-to: references:mime-version; bh=Ynl0XgT+0di5rilejzxs5qpWfnnc5Fk1NmrCxj3BZdE=; b=dyk5p8iWsmwTW+2jiQfVV8dil8ZxsXwcqsB5Bb0liHzcnDEIk2K2NRBv R8L5KXrDqOPE4ij6zHjbfnc0t9fvYhnMbpmU4ybXNrqUHBG5fWVC/dXRM nxxL1HL5OBPF3pUdddpJ/18Bvg3PY7q2ttSX5BPSDXAb1haqNaDme2ykY 35pFPnXJbO2YHbfeTkWDdr0762VHktl4YntfKuwxP7IRP2QmM6PjKJy13 NssjxBtZOGvi9JpR50Xd/pCeQ/RDc9CWt0Hj4fdksXdy8f10DlyqEE9G9 iRLO4jHWSzxv9NRE0DRNk8OCZWKTs6te+uxqLHfAdXR/fN8nlpy8OpnPR Q==; X-CSE-ConnectionGUID: IDIk9/YLT5O/kgNIcDcOYg== X-CSE-MsgGUID: HtRmnp4vQo6ffgUkaz+p/g== X-IronPort-AV: E=McAfee;i="6700,10204,11111"; a="19976757" X-IronPort-AV: E=Sophos;i="6.08,258,1712646000"; d="scan'208";a="19976757" Received: from fmviesa010.fm.intel.com ([10.60.135.150]) by fmvoesa106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 22 Jun 2024 09:03:04 -0700 X-CSE-ConnectionGUID: GZenyGoDRGyglmggGYZZRg== X-CSE-MsgGUID: KiKuvtY8T3mAlbhVR2f9EA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.08,258,1712646000"; d="scan'208";a="42972923" Received: from orsosgc001.jf.intel.com (HELO orsosgc001.intel.com) ([10.165.21.138]) by fmviesa010-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 22 Jun 2024 09:03:04 -0700 Date: Sat, 22 Jun 2024 09:03:04 -0700 Message-ID: <8534p5q81z.wl-ashutosh.dixit@intel.com> From: "Dixit, Ashutosh" To: Michal Wajdeczko Cc: Rodrigo Vivi , Subject: Re: [PATCH] drm/xe/oa: Fix 'enum drm_xe_perf_type' kernel doc warnings In-Reply-To: References: <20240621190903.3593781-1-ashutosh.dixit@intel.com> <508be309-17c8-419a-92b4-91cd06d2cb6b@intel.com> <87wmmihtbw.wl-ashutosh.dixit@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/28.2 (x86_64-redhat-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 Sat, 22 Jun 2024 02:17:11 -0700, Michal Wajdeczko wrote: > Hi Michal, > > > On 21.06.2024 23:36, Dixit, Ashutosh wrote: > > 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 > > hmm, but below diff works for me: > > diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h > index 93e00be44b2d..081e584240e6 100644 > --- a/include/uapi/drm/xe_drm.h > +++ b/include/uapi/drm/xe_drm.h > @@ -1379,7 +1379,9 @@ 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, > + /* private: */ > __DRM_XE_PERF_TYPE_MAX, /* non-ABI */ > }; > > > make sure you don't use /** private: */ as this might be not recognized Yup that was the issue. > > OTOH, if __DRM_XE_PERF_TYPE_MAX is not a real ABI definition, why did we > put this into uabi header? I have now removed it. > > see also DRM_XE_OA_PROPERTY_MAX that IMO should be either removed from > uabi or at least marked as a 'private' I have fixed this up in v2 here: https://patchwork.freedesktop.org/series/135225/ It is used internally so can't remove it, but have named it __DRM_XE_OA_PROPERTY_MAX and marked it as private. > > + Rodrigo Thanks. -- Ashutosh