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 3CC16A0548; Wed, 19 May 2021 19:23:44 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A40BD40041; Wed, 19 May 2021 19:23:43 +0200 (CEST) Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by mails.dpdk.org (Postfix) with ESMTP id D2C284003F for ; Wed, 19 May 2021 19:23:42 +0200 (CEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id 1C4BC5C012C; Wed, 19 May 2021 13:23:41 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Wed, 19 May 2021 13:23:41 -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= z6EQeODwmoioTV5ZnhdvXCub7Iddc/jOgW5CCUneNxw=; b=DUFAuR+ukKVH/GMt hQZPzg04bRA6U1UdqBaF4iQirpmwU8l3DumK6x5MvDRoA57g+DeA6o6EI2RMa09b 7zn1oXDHG/NksxtuxnQTs0ZkuNhTYZx/GS49lQMaspdr2Sc+3Ap/Ce0oM7bYxsVG s85M0Uosc5qBscxizYxSIg73l9SGhu07mcsrpwXdvSvwOklAguv9kLrnlf+dhPgr M7h+BwTFiuV3ocOBL1UyiWny9XdVybPRYsRygBUy895YXXIjoR3ZReoCGg8Y7JSr EiWe87UxqZgRtr0avgHwwxD2cLuf2h6dPbQPGHku+F7QILG59FrGoxLDfzRxoC0G Z28SZw== 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=z6EQeODwmoioTV5ZnhdvXCub7Iddc/jOgW5CCUneN xw=; b=YkU0fZm84INUpT+y/o+G7+dKeDqtkIAHI2FGskmhfZ85L0xOTGR5q3Qpq skdJsfjySXNzha806JIJxuvqVpfg4FyCgF/ezRv4jTxYn3co32GwICLZKUn49PWz iZGjpByAzs5JJlvLYkDCM+5e2A8qKDzC+EJssoXDwtx0XyQwpvzLPWGWN5DKeivW 85MwTzBLuhcjG2uRt0aYsU+p7UFRhoTPCa3W7NVc/TzIowY3B16Xu9ZZuqRPRURF xAPFfPFLI/w3H3aI8COeP5EvET9l4oVXNbB2+Awr/C2HNryUxp2Qbzd8vjitanyY XEC2vPGrwnre+2F+FBQ2RGq+g/n4Q== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvdeiledgudduudcutefuodetggdotefrod 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:23:38 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org, Ferruh Yigit Cc: Ori Kam , Andrew Rybchenko , Ajit Khaparde Date: Wed, 19 May 2021 19:23:37 +0200 Message-ID: <3799581.e9Ixlid1rX@thomas> In-Reply-To: References: <20210519162725.2179226-1-thomas@monjalon.net> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH] 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 18:53, Ferruh Yigit: > On 5/19/2021 5:27 PM, Thomas Monjalon wrote: > > The Doxygen comments are placed before the related lines, > > but the markers were /**< instead of /** > > > > Fixes: b10a421a1f3b ("ethdev: add packet integrity check flow rules") > > > > Signed-off-by: Thomas Monjalon > > --- > > lib/ethdev/rte_flow.h | 18 +++++++++--------- > > 1 file changed, 9 insertions(+), 9 deletions(-) > > > > diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h > > index 94c8c1ccc8..d7e0082dc7 100644 > > --- a/lib/ethdev/rte_flow.h > > +++ b/lib/ethdev/rte_flow.h > > @@ -1708,7 +1708,7 @@ rte_flow_item_geneve_opt_mask = { > > #endif > > > > struct rte_flow_item_integrity { > > - /**< Tunnel encapsulation level the item should apply to. > > + /** Tunnel encapsulation level the item should apply to. > > * @see rte_flow_action_rss > > */ > > uint32_t level; > > @@ -1716,21 +1716,21 @@ struct rte_flow_item_integrity { > > union { > > __extension__ > > struct { > > - /**< The packet is valid after passing all HW checks. */ > > + /** The packet is valid after passing all HW checks. */ > > uint64_t packet_ok:1; > > - /**< L2 layer is valid after passing all HW checks. */ > > + /** L2 layer is valid after passing all HW checks. */ > > uint64_t l2_ok:1; > > - /**< L3 layer is valid after passing all HW checks. */ > > + /** L3 layer is valid after passing all HW checks. */ > > uint64_t l3_ok:1; > > - /**< L4 layer is valid after passing all HW checks. */ > > + /** L4 layer is valid after passing all HW checks. */ > > uint64_t l4_ok:1; > > - /**< L2 layer CRC is valid. */ > > + /** L2 layer CRC is valid. */ > > uint64_t l2_crc_ok:1; > > - /**< IPv4 layer checksum is valid. */ > > + /** IPv4 layer checksum is valid. */ > > uint64_t ipv4_csum_ok:1; > > - /**< L4 layer checksum is valid. */ > > + /** L4 layer checksum is valid. */ > > uint64_t l4_csum_ok:1; > > - /**< The l3 length is smaller than the frame length. */ > > + /** L3 length is smaller than frame length. */ > > uint64_t l3_len_ok:1; > > uint64_t reserved:56; > > }; > > > > +1 to fix but the struct is not listed at all in the API documentation, because > it is missing Doxygen comment for the struct itself. > > Can it be possible to add a doxygen comment for the struct, even it is very > basic, to enable it to be documented? Yes OK