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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (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 D056CCD11C2 for ; Thu, 21 Mar 2024 15:35:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:From:References:Cc:To: Subject:MIME-Version:Date:Message-ID:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=pYpGL+S3pVRoXZ7QINHSNMdYJWZ/PcB8KFwzH6uYK+g=; b=eKoa4Qpx6/5huG Kk1++Wrz45LZUXBn8yC1xSg0fGcN1BRiSZOoN2iehWfhGqNOuyZKJ8oAnD7edrL5tCxidx25ahmX+ Jqt1IPJ+KQnVPScnAg0ZS3cGjcZh7wO6mDbATrk7ksp14uyfkUqvGRsSQmEElF8/RKE6KhUSY000N CLEl2r1YCqE60QyRZeesp3FDfs4BuIwSGaaL6GPiRjo4fMvDV8KTmY4gv/FW7gNGRlWUvoFH0Cf+u u8xa98lSXs0CIIbk0lnbdV+3R9KT3qh+QBsPfaMBjmbmXAqqUemghUl9nyd3QljlKDr0FOHeACaxV xXm4rgNUoMUNqC0axtkw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1rnKRV-00000003XIV-1rY4; Thu, 21 Mar 2024 15:34:57 +0000 Received: from out-173.mta1.migadu.com ([95.215.58.173]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1rnKQg-00000003Wdv-3CJN for linux-arm-kernel@lists.infradead.org; Thu, 21 Mar 2024 15:34:19 +0000 Message-ID: <2c38ac1c-cc0e-43b3-86d3-5b6a2f00f9e7@linux.dev> DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.dev; s=key1; t=1711035238; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=XcnhGHIAXVuRsv4I7TSZ/EDA+Yw6Y/dChRxdQ571Ims=; b=E3s41Xaaumg9Q3b3HHjrJAk+X6nZFsmGTFFJijUT4my3g35hQDUK4Dy6V6Uv+DSeQJ2nlM g/Fe36s3KsD2tF4r2fe/ROT2RF/Y0xqsdijJZo6Wm/ozQKbzJK8+yrCmC0EJI/4Y00gWGa /NUb+IB+brWq0eM+xTZqXw5VovE6+kI= Date: Thu, 21 Mar 2024 11:33:52 -0400 MIME-Version: 1.0 Subject: Re: [PATCH v2 1/8] drm: xlnx: Fix kerneldoc Content-Language: en-US To: Randy Dunlap , Tomi Valkeinen Cc: Michal Simek , David Airlie , linux-kernel@vger.kernel.org, Daniel Vetter , linux-arm-kernel@lists.infradead.org, Laurent Pinchart , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , dri-devel@lists.freedesktop.org References: <20240319225122.3048400-1-sean.anderson@linux.dev> <20240319225122.3048400-2-sean.anderson@linux.dev> X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Sean Anderson In-Reply-To: X-Migadu-Flow: FLOW_OUT X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240321_083407_165036_152E8A84 X-CRM114-Status: GOOD ( 22.92 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On 3/20/24 02:05, Randy Dunlap wrote: > > > On 3/19/24 22:42, Tomi Valkeinen wrote: >> On 20/03/2024 00:51, Sean Anderson wrote: >>> Fix a few errors in the kerneldoc. Mostly this addresses missing/renamed >>> members. >>> >>> Signed-off-by: Sean Anderson >>> --- >>> >>> Changes in v2: >>> - New >>> >>> drivers/gpu/drm/xlnx/zynqmp_disp.c | 6 +++--- >>> drivers/gpu/drm/xlnx/zynqmp_dpsub.h | 1 + >>> drivers/gpu/drm/xlnx/zynqmp_kms.h | 4 ++-- >>> 3 files changed, 6 insertions(+), 5 deletions(-) >>> >>> diff --git a/drivers/gpu/drm/xlnx/zynqmp_disp.c b/drivers/gpu/drm/xlnx/zynqmp_disp.c >>> index 407bc07cec69..f79bf3fb8110 100644 >>> --- a/drivers/gpu/drm/xlnx/zynqmp_disp.c >>> +++ b/drivers/gpu/drm/xlnx/zynqmp_disp.c >>> @@ -128,9 +128,9 @@ struct zynqmp_disp_layer { >>> * struct zynqmp_disp - Display controller >>> * @dev: Device structure >>> * @dpsub: Display subsystem >>> - * @blend.base: Register I/O base address for the blender >>> - * @avbuf.base: Register I/O base address for the audio/video buffer manager >>> - * @audio.base: Registers I/O base address for the audio mixer >>> + * @blend: Register I/O base address for the blender >>> + * @avbuf: Register I/O base address for the audio/video buffer manager >>> + * @audio: Registers I/O base address for the audio mixer >> >> Afaics, the kernel doc guide: >> >> https://docs.kernel.org/doc-guide/kernel-doc.html#nested-structs-unions >> >> says that the current version is correct. Or is the issue that while, say, 'base' is documented, 'blend' was not? > > Hi, > > I would do it more like so: > > --- > drivers/gpu/drm/xlnx/zynqmp_disp.c | 3 +++ > 1 file changed, 3 insertions(+) > > diff -- a/drivers/gpu/drm/xlnx/zynqmp_disp.c b/drivers/gpu/drm/xlnx/zynqmp_disp.c > --- a/drivers/gpu/drm/xlnx/zynqmp_disp.c > +++ b/drivers/gpu/drm/xlnx/zynqmp_disp.c > @@ -128,8 +128,11 @@ struct zynqmp_disp_layer { > * struct zynqmp_disp - Display controller > * @dev: Device structure > * @dpsub: Display subsystem > + * @blend: blender iomem info > * @blend.base: Register I/O base address for the blender > + * @avbuf: audio/video buffer iomem info > * @avbuf.base: Register I/O base address for the audio/video buffer manager > + * @audio: audio mixer iomem info > * @audio.base: Registers I/O base address for the audio mixer > * @layers: Layers (planes) > */ > > > but in my testing, Sean's way or my way result in no warning/errors. > The specific errors are: ../drivers/gpu/drm/xlnx/zynqmp_disp.c:151: warning: Function parameter or struct member 'blend' not described in 'zynqmp_disp' ../drivers/gpu/drm/xlnx/zynqmp_disp.c:151: warning: Function parameter or struct member 'avbuf' not described in 'zynqmp_disp' ../drivers/gpu/drm/xlnx/zynqmp_disp.c:151: warning: Function parameter or struct member 'audio' not described in 'zynqmp_disp' I don't see the need to document a single-member struct twice. Actually, maybe it would be better to just lift the .base member to live in zynqmp_disp. But I think that would be better in another series. --Sean _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel