From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 51311A0548; Wed, 19 May 2021 20:03:07 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id CAC7140041; Wed, 19 May 2021 20:03:06 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id BA4CF4003F for ; Wed, 19 May 2021 20:03:04 +0200 (CEST) IronPort-SDR: 8I2jph2rtNyRguseF3lHAjW+q7Wbzi4DZ8KAu2w2ODjplZPksmpV87R135fCKglyv/D0jth4n7 //rG0VKewIOg== X-IronPort-AV: E=McAfee;i="6200,9189,9989"; a="200736150" X-IronPort-AV: E=Sophos;i="5.82,313,1613462400"; d="scan'208";a="200736150" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 May 2021 11:03:03 -0700 IronPort-SDR: jJLenW+MHhrJhFUh2DqedzkuQcI2Gn+1GtuJjE9p/ZRypdI8K/oANQd47hpLUXKZizKE/4WXDN BgmF0ATapdLw== X-IronPort-AV: E=Sophos;i="5.82,313,1613462400"; d="scan'208";a="411834621" Received: from fyigit-mobl1.ger.corp.intel.com (HELO [10.213.224.148]) ([10.213.224.148]) by orsmga002-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 May 2021 11:03:00 -0700 To: Thomas Monjalon Cc: dev@dpdk.org, asafp@nvidia.com, Andrew Rybchenko , Ajit Khaparde , Ori Kam , bingz@nvidia.com References: <20210519162725.2179226-1-thomas@monjalon.net> <20210519173316.2364189-1-thomas@monjalon.net> <2193430.dtPu5APMcE@thomas> From: Ferruh Yigit X-User: ferruhy Message-ID: <86c69335-296a-7482-66ef-188bd2ccf904@intel.com> Date: Wed, 19 May 2021 19:02:56 +0100 MIME-Version: 1.0 In-Reply-To: <2193430.dtPu5APMcE@thomas> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Subject: Re: [dpdk-dev] [PATCH v2] ethdev: fix comments of packet integrity flow item X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On 5/19/2021 6:59 PM, Thomas Monjalon wrote: > 19/05/2021 19:47, Ferruh Yigit: >> On 5/19/2021 6:33 PM, Thomas Monjalon wrote: >>> The Doxygen comments are placed before the related lines, >>> but the markers were /**< instead of /** >>> >>> The struct rte_flow_item_integrity did not appear in Doxygen output >>> because there was no general comment for the struct. >>> >>> Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules") >>> >>> Signed-off-by: Thomas Monjalon >>> Acked-by: Andrew Rybchenko >>> Acked-by: Ajit Khaparde >> >> Reviewed-by: Ferruh Yigit >> >> >> btw, there are some related issues for other structs, do you think should we fix >> them in this release? >> >> Following are missing doxygen comment for its item: >> * "struct rte_flow_item_conntrack" >> * "struct rte_flow_item_ecpri" >> >> * Following are missing doxygen comments for its items, and missing experimental >> tag. >> * "struct rte_flow_item_geneve_opt" >> * "struct rte_flow_item_ipv6_frag_ext" >> >> And I suspect we can see similar issues with more structs as we check them all. > > Except GENEVE, they are singleton (one member in the struct), > so it is not a big deal. > Given they are missing comment (not wrong), I propose to wait the next release > for making rte_flow doxygen more complete. > I plan to have a look at the rst doc as well. > > OK