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 681CDC71153 for ; Mon, 28 Aug 2023 19:33:49 +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=4jFMvT30JvvKUApdW3X4xzkNmCYISyxl1wNQb5Qenoc=; b=Tif2/ieaUhX4th xiTKTmdIz+FuIGKmPTW/JhKyiOOvlwhAuZ0jtje0k87Q6LbaCXp1YfPnE9dIMsEgheFVuRHlfWhqM 3kwa8Nz5+LkzRptloUa0abKKnlRT107jmmmyeobIfjEzYQ7pf+uOJabr8Q4+kTRYb3x8qCHXEzE/N SynC71z23lhj4qrz5Ai1ukTpqFc94f0CmRxByZ8J++Y8VUICAUugnZgmbT7KNIx7wKn9Mn8p0tvWo QSK6jAA8tpib8pk4vGWdfNog+9dt45Wo67GsXc84nq32EUpIF4C/XEvJPYPMIMaoOB9Z5fY9fHmKO uS8oc1egn+o1Qq9WcTHA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1qahzE-00AA1Z-09; Mon, 28 Aug 2023 19:33:20 +0000 Received: from [2601:1c2:980:9ec0::2764] by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qahzC-00AA1F-1u; Mon, 28 Aug 2023 19:33:18 +0000 Message-ID: <05e511c7-596d-c9c6-51d8-8883c6a62599@infradead.org> Date: Mon, 28 Aug 2023 12:33:14 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.14.0 Subject: Re: [PATCH 01/20] drm/xlnx/zynqmp_disp: Use correct kerneldoc formatting in zynqmp_disp Content-Language: en-US To: Laurent Pinchart , Lee Jones Cc: linux-kernel@vger.kernel.org, Hyun Kwon , David Airlie , Daniel Vetter , Michal Simek , dri-devel@lists.freedesktop.org, linux-arm-kernel@lists.infradead.org References: <20230824073710.2677348-1-lee@kernel.org> <20230824073710.2677348-2-lee@kernel.org> <20230828163925.GU14596@pendragon.ideasonboard.com> From: Randy Dunlap In-Reply-To: <20230828163925.GU14596@pendragon.ideasonboard.com> 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 Hi-- On 8/28/23 09:39, Laurent Pinchart wrote: > Hi Lee, > > Thank you for the patch. > > On Thu, Aug 24, 2023 at 08:36:46AM +0100, Lee Jones wrote: >> Fixes the following W=1 kernel build warning(s): >> >> drivers/gpu/drm/xlnx/zynqmp_disp.c:151: warning: Function parameter or member 'blend' not described in 'zynqmp_disp' >> drivers/gpu/drm/xlnx/zynqmp_disp.c:151: warning: Function parameter or member 'avbuf' not described in 'zynqmp_disp' >> drivers/gpu/drm/xlnx/zynqmp_disp.c:151: warning: Function parameter or member 'audio' not described in 'zynqmp_disp' >> >> Signed-off-by: Lee Jones >> --- >> Cc: Hyun Kwon >> Cc: Laurent Pinchart >> Cc: David Airlie >> Cc: Daniel Vetter >> Cc: Michal Simek >> Cc: dri-devel@lists.freedesktop.org >> Cc: linux-arm-kernel@lists.infradead.org >> --- >> drivers/gpu/drm/xlnx/zynqmp_disp.c | 6 +++--- >> 1 file changed, 3 insertions(+), 3 deletions(-) >> >> diff --git a/drivers/gpu/drm/xlnx/zynqmp_disp.c b/drivers/gpu/drm/xlnx/zynqmp_disp.c >> index 407bc07cec69a..7c64ab11fe2b0 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: .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 > > This is really a hack to work around the warning, and not a clean fix. > kerneldoc is still today unable, as far as I understand, to document > nested structures. That's annoying, and the warning is a good way to kernel-doc for nested structs/unions is documented in Documentation/doc-guide/kernel-doc.rst. This isn't pretty, but this fixes the warnings for me: (massage the descriptions as you see fit) --- 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 struct * @blend.base: Register I/O base address for the blender + * @avbuf: audio/video buffer manager struct * @avbuf.base: Register I/O base address for the audio/video buffer manager + * @audio: audio mixer struct * @audio.base: Registers I/O base address for the audio mixer * @layers: Layers (planes) */ > remind us that it needs to be fixed. I'd be tempted to keep the warning > for that reason. > >> * @layers: Layers (planes) >> */ >> struct zynqmp_disp { > -- ~Randy _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel