Received: by 2002:a05:7412:3784:b0:e2:908c:2ebd with SMTP id jk4csp588370rdb; Sat, 30 Sep 2023 18:17:12 -0700 (PDT) X-Google-Smtp-Source: AGHT+IETOwZ1++SgM8X73FsympzJls43Kab5rVbgHCctFCuMehK4/l/SEA4LzxRO1OLPT0j9ajME X-Received: by 2002:a05:6870:7026:b0:1d6:5133:2f37 with SMTP id u38-20020a056870702600b001d651332f37mr9928734oae.48.1696123031774; Sat, 30 Sep 2023 18:17:11 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1696123031; cv=none; d=google.com; s=arc-20160816; b=DDKYDo6/vUkqlakNFvjjMRCaptZYL+AX5ZGr/wC9gMjhB36yZV2fN36shZK7kRRTAz /svR85Bf/pecCJoGEk99UmqyVdXu4LCP7z0hbDHzX/2B48A07EqC6fsgMHhyP7g5+6I6 2+8NWj8U+IEFjMiV/tzk/kizpvAu1lYSqVhViDc/I50kJkU+n46h7PzmyDJL7QyK9Bo6 ajbviQ5q6a04tkWOWH0b8kLdbH7+ZLku5Oiocy8nRx9mdZ4Qwnt2U5rrZ8V/8w3KV+v9 KiW261/esFzB511zlAQWD6eEDUEdjzV9u2VQycZ8+w7bHG3DHHdvVKXZKY1yETXoGYag hqWw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:in-reply-to:from :content-language:references:cc:to:subject:user-agent:mime-version :date:message-id:dkim-signature; bh=C60Ncv2vQB/DJw8skCHwr3eVbL772Jn31RAnGa36VLA=; fh=oSjlZRBfSm6oBG7QjAzgHjwB/gDNMugsSYr0LsL1v1M=; b=F7TQSRsXeFykIDJIKvREvu5D8fzcMqcW3LPAVbYQ6jOyoEyXcnS4mvsGg5eVKHgIPb V9wC7vyiyS5t4dqBiFGTXk9uCkapO4wTklFP50YTda9U1YmKNd1uXrQBAdQcB/JXA06w wPj/qmiYdG+W5q+m8hSBZiF58QNmSWopalwKyoB4ZaTsOMRprT+d0B4LfsYWhvP20xCf ZwcnmsdNqO9p14Ar/vC88a6EhAQgn+HWJoaN8TMnn9EreUHdfoTSoAFY9lyboaz2EJXJ yrTtrX4OK5XbpEwdezFOGckByNE/jEArk+jsXj++ronpiNOYPdSV6v4yeJOO7XvoXMY8 fgUA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b=GMfctbW1; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from agentk.vger.email (agentk.vger.email. [23.128.96.32]) by mx.google.com with ESMTPS id t23-20020a656097000000b00577f4d85fdbsi13371583pgu.548.2023.09.30.18.17.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 30 Sep 2023 18:17:11 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 as permitted sender) client-ip=23.128.96.32; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b=GMfctbW1; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by agentk.vger.email (Postfix) with ESMTP id 3081A8191676; Sat, 30 Sep 2023 18:08:35 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at agentk.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234230AbjJABIL (ORCPT + 99 others); Sat, 30 Sep 2023 21:08:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42362 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231989AbjJABIJ (ORCPT ); Sat, 30 Sep 2023 21:08:09 -0400 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2B859D3; Sat, 30 Sep 2023 18:08:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date:Message-ID:Sender :Reply-To:Content-ID:Content-Description; bh=C60Ncv2vQB/DJw8skCHwr3eVbL772Jn31RAnGa36VLA=; b=GMfctbW1Rzk/Rs2dC0cOIpycOt xNUjrBSOyNCycybZ6jBXYPcTz7F7lLzLWwKx/qN+KfK734FjcsJMwH12JouUUQBOtLEgJbzyuXz1r QP4CqU3nJTvcqNQ59DOdNeDeBs/s5Dac25zNNaLSZf6lyPhDBWiz0yL6q+5cjNXoWv/aKp6++l4Rd Y6xrAQD/aJVWoBuGq0vhlGALsd7sb6Q/p3RekDPR6k42qEhp1/3JfPojk/ejvufd0FTVdA8aUAUdy L6nzBkG49ptbemg+wnlStwhKuRyjCKBRlxB0ykc1E9+4G0avYqDdK0BRBc3SV9Sfy+rc2wKvLseJC QqgdBsdQ==; Received: from [2603:3004:644:9100::a64a] by casper.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1qmkwE-000QhJ-3w; Sun, 01 Oct 2023 01:08:02 +0000 Message-ID: <7f62045b-aac1-498f-8f5a-6b94b4b5a096@infradead.org> Date: Sat, 30 Sep 2023 18:07:55 -0700 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH] platform/mellanox: tmfifo: fix kernel-doc warnings To: =?UTF-8?Q?Ilpo_J=C3=A4rvinen?= Cc: LKML , kernel test robot , Liming Sun , Hans de Goede , Mark Gross , Vadim Pasternak , platform-driver-x86@vger.kernel.org, Mauro Carvalho Chehab References: <20230926054013.11450-1-rdunlap@infradead.org> <7b57bf9d-b024-b435-54ca-6ab5916197a1@linux.intel.com> Content-Language: en-US From: Randy Dunlap In-Reply-To: <7b57bf9d-b024-b435-54ca-6ab5916197a1@linux.intel.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on agentk.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (agentk.vger.email [0.0.0.0]); Sat, 30 Sep 2023 18:08:35 -0700 (PDT) Hi, On 9/26/23 09:18, Ilpo Järvinen wrote: > On Mon, 25 Sep 2023, Randy Dunlap wrote: > >> Fix kernel-doc notation for structs and struct members to prevent >> these warnings: >> >> mlxbf-tmfifo.c:73: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_vring ' >> mlxbf-tmfifo.c:128: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_vdev ' >> mlxbf-tmfifo.c:146: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_irq_info ' >> mlxbf-tmfifo.c:158: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_io ' >> mlxbf-tmfifo.c:182: warning: cannot understand function prototype: 'struct mlxbf_tmfifo ' >> mlxbf-tmfifo.c:208: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_msg_hdr ' >> mlxbf-tmfifo.c:138: warning: Function parameter or member 'config' not described in 'mlxbf_tmfifo_vdev' >> mlxbf-tmfifo.c:212: warning: Function parameter or member 'unused' not described in 'mlxbf_tmfifo_msg_hdr' >> >> Fixes: 1357dfd7261f ("platform/mellanox: Add TmFifo driver for Mellanox BlueField Soc") >> Fixes: bc05ea63b394 ("platform/mellanox: Add BlueField-3 support in the tmfifo driver") >> Signed-off-by: Randy Dunlap >> Reported-by: kernel test robot >> Closes: lore.kernel.org/r/202309252330.saRU491h-lkp@intel.com >> Cc: Liming Sun >> Cc: Hans de Goede >> Cc: Ilpo Järvinen >> Cc: Mark Gross >> Cc: Vadim Pasternak >> Cc: platform-driver-x86@vger.kernel.org >> --- >> drivers/platform/mellanox/mlxbf-tmfifo.c | 14 ++++++++------ >> 1 file changed, 8 insertions(+), 6 deletions(-) >> >> diff -- a/drivers/platform/mellanox/mlxbf-tmfifo.c b/drivers/platform/mellanox/mlxbf-tmfifo.c >> --- a/drivers/platform/mellanox/mlxbf-tmfifo.c >> +++ b/drivers/platform/mellanox/mlxbf-tmfifo.c >> @@ -53,7 +53,7 @@ >> struct mlxbf_tmfifo; >> >> /** >> - * mlxbf_tmfifo_vring - Structure of the TmFifo virtual ring >> + * struct mlxbf_tmfifo_vring - Structure of the TmFifo virtual ring >> * @va: virtual address of the ring >> * @dma: dma address of the ring >> * @vq: pointer to the virtio virtqueue >> @@ -113,12 +113,13 @@ enum { >> }; >> >> /** >> - * mlxbf_tmfifo_vdev - Structure of the TmFifo virtual device >> + * struct mlxbf_tmfifo_vdev - Structure of the TmFifo virtual device >> * @vdev: virtio device, in which the vdev.id.device field has the >> * VIRTIO_ID_xxx id to distinguish the virtual device. >> * @status: status of the device >> * @features: supported features of the device >> * @vrings: array of tmfifo vrings of this device >> + * @config: non-anonymous union for cons and net > > I wonder what information this adds? It's not documenting anything else > than C syntax, IMO. > > Would it be possible to make kerneldoc not give warning from a named union > which is already fully documented? I don't know. Maybe. I have no idea if anyone has ever looked into doing that. I'm adding Mauro since he did the nested struct/union kernel-doc code. ~Randy