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 F0FFCA0548; Wed, 19 May 2021 19:59:56 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6E2D540041; Wed, 19 May 2021 19:59:56 +0200 (CEST) Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by mails.dpdk.org (Postfix) with ESMTP id BBF324003F for ; Wed, 19 May 2021 19:59:54 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 656475C016A; Wed, 19 May 2021 13:59:54 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute1.internal (MEProxy); Wed, 19 May 2021 13:59:54 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=fm1; bh= 2/sVS3pwILCD2cMEkx9das9G7i/kPJS3Mlvqq2npLxc=; b=f7lSJszqEXpil7sK dU5TPFabUM6ZDiQIazkEhIuabf+xaMnJ8UUXsa6Wszg1xfYRr2VKzrrdrrTJ005P FtzgxFd28gQOejJPMd+83/PgsXh9OsXUPtIw/OLQndeU8bAADCTUR+wcC8Z4vVIO GmSJJa+MN1995uhRPmKRiGEev/8AMHHsMTZrKAnPMlSi/BqKjdJ3ndQvUurZk/dF icspZs2cWmputa70HCx/z/RQZtQ4Nu5eFRHi6XITFLpDpLXvdFuKFnEErahLD1my o57BhSuKGalUClz48VuLtyyOBDcEmWw3rk9bEWXPdZc0a3jGNtUFltZY/D/DJCSE Zq4ItQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm2; bh=2/sVS3pwILCD2cMEkx9das9G7i/kPJS3Mlvqq2npL xc=; b=Mo3YeUru/1DRFN6wqLxwRiO22vA4t/Jx1mP2B959aqo+QuohHHLZdJOke C6mPX04OFCyCfCLF5TjiA/5y6eEBdy3JUPYAunbX9NKeEeIT9EYab/EzeP1br8wg iMyNJOUigv/3zQkid/mnAA0Pgq57Yx8aq5nKQC0ByhA9u4LR3HLzmWwqK5GN7lp5 Yrqfui1PGgAjTdWZPuTDmENXWVcCJ1cGR6YAbOwypkPSbA8FtlSG4CU+CSdHpPcy DyiBy+J95JoTppZOXbnQQ8XA3nn4z1hNymLh+aR72+9YCZnC49C1nsuWRWBTuQOd 1GlEIqk6ubTe9JZLMDu7HEVOceLMw== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvdeiledguddukecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpefhvffufffkjghfggfgtgesthfuredttddtvdenucfhrhhomhepvfhhohhm rghsucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenuc ggtffrrghtthgvrhhnpedugefgvdefudfftdefgeelgffhueekgfffhfeujedtteeutdej ueeiiedvffegheenucfkphepjeejrddufeegrddvtdefrddukeegnecuvehluhhsthgvrh fuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgr lhhonhdrnhgvth X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 19 May 2021 13:59:52 -0400 (EDT) From: Thomas Monjalon To: Ferruh Yigit Cc: dev@dpdk.org, asafp@nvidia.com, Andrew Rybchenko , Ajit Khaparde , Ori Kam , bingz@nvidia.com Date: Wed, 19 May 2021 19:59:51 +0200 Message-ID: <2193430.dtPu5APMcE@thomas> In-Reply-To: References: <20210519162725.2179226-1-thomas@monjalon.net> <20210519173316.2364189-1-thomas@monjalon.net> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" 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" 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.