From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7F5BCA0562; Wed, 14 Apr 2021 11:01:20 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 5D8D716188F; Wed, 14 Apr 2021 11:01:20 +0200 (CEST) Received: from new1-smtp.messagingengine.com (new1-smtp.messagingengine.com [66.111.4.221]) by mails.dpdk.org (Postfix) with ESMTP id 6728E16186E for <dev@dpdk.org>; Wed, 14 Apr 2021 11:01:18 +0200 (CEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailnew.nyi.internal (Postfix) with ESMTP id 1196D5803D1; Wed, 14 Apr 2021 05:01:18 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Wed, 14 Apr 2021 05:01:18 -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=fm3; bh= gzbpHR7HZm+EZDk/1qOPec2Ot64BM2sEArLhytQcoOI=; b=nZxUgnCK2/peOl/5 G+N+EaHT+cjIMsH+qGAZC1xynM77xwbKa8pyF63hR3AfdlbI1NvhO2pZ6lNXDgx6 F6UNd1/V7CvFQHBl4IWlcs0xSo5QHMUwL9UK/gSK9YqB8/l+duD5RC9FUNN6YURt 1hc1y5WNDXLKql/EedDbueYYuCPxlvBefoaq3FKC+x/J/kPlA05ZkIOF5crJoQlC EaDQbtvIUOfK7xudb9mQ4yhH6vnJLxQxAJ/QCF9Irazju3Fkm/UcGWg4rNG1YxgX XZzy6VQcl095maQTPq1qn3x/uFfr+FnJHEFsF9U8Vk4cSGjjv6NLvKp0/rNKpNPZ vTz4QA== 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=gzbpHR7HZm+EZDk/1qOPec2Ot64BM2sEArLhytQco OI=; b=MwbPu9p7G3d1asJQc6SlDpOltRhl0QoYzW6YVmElI4fJXgYkLTM1vQyOx SloNwelnpvMEMVCM8BMtG/Ql4Lf/qbaTniuziyqZLn5owHASelfzNVbQ0//nEHec BRpku+KG0/NOHz+fPWK3ceUX0eC87dN0+z/LJ50V3jU4QsorljJamQPyMpYYIZO1 uNJX5Kbk5OkwWJZGkuuNwvPgirCG7d8Wa+rfIwBpBpyuNEe2aAD/Smy0yc73/Zxk DahqZl5MCtY7qAM/vMjoeMF87fYi8JBduNLQrE+SleIKbyL9d932gPreI+moDcmx kR8xKFG1moNmwRvaXbgyzjb1BEvQg== X-ME-Sender: <xms:Xa92YH7gvNtZ0vkt9D4Mqw1SPJgfp0XPwRiGJyxVk1F0tacSi2_w7A> <xme:Xa92YM7lOsGLbWpA5UUenC0p_bkfhrkbVuz65iOlBr1FgKiqsejzjrh1Qf9or_-9x OjvN-WmgFppoVqeUA> X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrudeluddgudduucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvufffkfgjfhgggfgtsehtufertddttddvnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepudeggfdvfeduffdtfeeglefghfeukefgfffhueejtdetuedtjeeu ieeivdffgeehnecukfhppeejjedrudefgedrvddtfedrudekgeenucevlhhushhtvghruf hiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghl ohhnrdhnvght X-ME-Proxy: <xmx:Xa92YOdE06UH7r8Llm-bPd8Fw4yhJCkbiZIfRUhEUtzw8LnCX3T3VQ> <xmx:Xa92YIJMs4ZS5ensksmSJS9HNKRHeqxL6iwmTIVHacnMBQM8F13G5w> <xmx:Xa92YLIjMPHyQyI_h75tt14CoWCCYczNWzIumgNaTbNzQ4cvF7jSAQ> <xmx:Xq92YFBlseWA8AZSvn63TIpSj82F9_CHzJkJ_GG0AltgPomPyAaqQQ> Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 9BB571080069; Wed, 14 Apr 2021 05:01:15 -0400 (EDT) From: Thomas Monjalon <thomas@monjalon.net> To: orika@nvidia.com Cc: dev@dpdk.org, Haifei Luo <haifeil@nvidia.com>, viacheslavo@nvidia.com, rasland@nvidia.com, xuemingl@nvidia.com, haifeil@nvidia.com, ajit.khaparde@broadcom.com, Xiaoyun Li <xiaoyun.li@intel.com>, Matan Azrad <matan@nvidia.com>, Shahaf Shuler <shahafs@nvidia.com>, Jerin Jacob <jerinj@marvell.com>, Nithin Dabilpuram <ndabilpuram@marvell.com>, Kiran Kumar K <kirankumark@marvell.com>, Ferruh Yigit <ferruh.yigit@intel.com>, Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru> Date: Wed, 14 Apr 2021 11:01:14 +0200 Message-ID: <17036885.Jqfv5cWjOq@thomas> In-Reply-To: <1618389706-183883-2-git-send-email-haifeil@nvidia.com> References: <1615277716-64404-1-git-send-email-haifeil@nvidia.com> <1618389706-183883-1-git-send-email-haifeil@nvidia.com> <1618389706-183883-2-git-send-email-haifeil@nvidia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH v4 1/3] ethdev: modify rte API for single flow dump X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> 14/04/2021 10:41, Haifei Luo: > Previous implementations support dump all the flows. Add new arg > rte_flow in rte_flow_dev_dump to dump one flow. > > Signed-off-by: Haifei Luo <haifeil@nvidia.com> > Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com> > Acked-by: Ori Kam <orika@nvidia.com> [...] > +Dump > +~~~~~ > + > +Dump information for all or one flows. > + > +.. code-block:: c > + > + int > + rte_flow_dev_dump(uint16_t port_id, struct rte_flow *flow, > + FILE *file, > + struct rte_flow_error *error); > + > +Arguments: > + > +- ``port_id``: port identifier of Ethernet device. > +- ``flow``: flow rule handle to dump. NULL to dump all. > +- ``file``: a pointer to a file for output > +- ``error``: perform verbose error reporting if not NULL. PMDs initialize > + this structure in case of error only. > + > +Return values: > + > +- 0 on success, a negative errno value otherwise and ``rte_errno`` is set. I really don't understand why we continue duplicating rte_flow doxygen in the guide. Please stop. Do one good API description in doxygen, and describe only the big picture and how-to in the guide.