From patchwork Wed Jul 21 15:58:14 2021
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Patchwork-Submitter: =?utf-8?q?Havl=C3=ADk_Martin?=
 <xhavli56@stud.fit.vutbr.cz>
X-Patchwork-Id: 96175
X-Patchwork-Delegate: ferruh.yigit@amd.com
Return-Path: <dev-bounces@dpdk.org>
X-Original-To: patchwork@inbox.dpdk.org
Delivered-To: patchwork@inbox.dpdk.org
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 7167BA0C51;
	Wed, 21 Jul 2021 17:58:41 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 5C6CE4014D;
	Wed, 21 Jul 2021 17:58:41 +0200 (CEST)
Received: from eva.fit.vutbr.cz (eva.fit.vutbr.cz [147.229.176.14])
 by mails.dpdk.org (Postfix) with ESMTP id E1D1640143
 for <dev@dpdk.org>; Wed, 21 Jul 2021 17:58:39 +0200 (CEST)
Received: from dpdk-test7.liberouter.org
 ([IPv6:2001:718:800:ff00:2eea:7fff:fef8:8792]) (authenticated bits=0)
 by eva.fit.vutbr.cz (8.16.1/8.16.1) with ESMTPSA id 16LFwVas082162
 (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384 bits=256 verify=NO);
 Wed, 21 Jul 2021 17:58:35 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=stud.fit.vutbr.cz;
 s=studfit; t=1626883116;
 bh=f9F/sXVTn2wNQijIwBM1ViVvSN6slMXTevrhcbpmMho=;
 h=From:To:Cc:Subject:Date;
 b=HXk7DwiLGonWwBWt/pJp5QTMbPQ5YXo1fdYr1ddWaqbX8jqs1QkKXTdKi8vxLaSTG
 fveRI6Z4JihmPp5ybb8jWWm4eukXSDWdofoh8swqfS1V2cERPKKK9DPJ5KfI832HQD
 bfwQVZxak9dndlFXMOqovyRXTtemdxaUFvmDsPkc=
From: Martin Havlik <xhavli56@stud.fit.vutbr.cz>
To: xhavli56@stud.fit.vutbr.cz, Ori Kam <orika@nvidia.com>,
 Ajit Khaparde <ajit.khaparde@broadcom.com>,
 Thomas Monjalon <thomas@monjalon.net>,
 Andrew Rybchenko <arybchenko@solarflare.com>,
 Ferruh Yigit <ferruh.yigit@intel.com>, Dekel Peled <dekelp@nvidia.com>,
 Bing Zhao <bingz@nvidia.com>, Gregory Etelson <getelson@nvidia.com>,
 Eli Britstein <elibr@mellanox.com>, Alexander Kozyrev <akozyrev@nvidia.com>
Cc: dev@dpdk.org, Jan Viktorin <viktorin@cesnet.cz>
Date: Wed, 21 Jul 2021 17:58:14 +0200
Message-Id: <20210721155816.188795-3-xhavli56@stud.fit.vutbr.cz>
X-Mailer: git-send-email 2.27.0
MIME-Version: 1.0
Subject: [dpdk-dev] [PATCH 2/4] doc: specify RTE flow create behaviour
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>

The ability to create RTE flow rules, depending on
port status, can and does differ between PMDs.
Now the doc reflects that.

Signed-off-by: Martin Havlik <xhavli56@stud.fit.vutbr.cz>
---
 doc/guides/prog_guide/rte_flow.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index 2b42d5ec8c..2988e3328a 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -3097,6 +3097,10 @@ actually created and a handle returned.
                    const struct rte_flow_action *actions[],
                    struct rte_flow_error *error);
 
+The ability to create a flow rule may depend on the status (started/stopped)
+of the port for which the rule is being created. This behaviour is
+PMD specific. Seek relevant PMD documentation for details.
+
 Arguments:
 
 - ``port_id``: port identifier of Ethernet device.