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 AC8C042B34 for ; Thu, 18 May 2023 19:40:43 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A109A42D31; Thu, 18 May 2023 19:40:43 +0200 (CEST) Received: from NAM10-DM6-obe.outbound.protection.outlook.com (mail-dm6nam10on2040.outbound.protection.outlook.com [40.107.93.40]) by mails.dpdk.org (Postfix) with ESMTP id 5153442BDA; Thu, 18 May 2023 19:40:42 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=nyOE73RX2clTNs283RoYf9QAPkuC1IdcUaoTCKfhhkh0fgYc/WfQiFPxHZ8BGsEMwWXvHM2St63Rmj0+18WV95PatNEwWUUe3oEwMD9uqQqSCEALx0lwCnGzBfmqcnF/fQZ7eF/7SSV5Sp67tgOBEdSWpHMkuMkrfv9IFIJ7R91gBZi64z87vzPGkNjSVtFRw9jKuLuqoY5d13HFrNofTTaBkPdpBE7dEjalsFnNFHyq02p2DQZbhKFm5+o2aCngmseoE5/YgKv9TfkDXow7RIHKWz6mPSum5Ho5WnNettLK++0oy6tpXavx0omHA4FiIruUm5L4jpzGe+Kn8llbbA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=3627LIotpgp6BILDvCXKuaDznZItiZ4j3jX8U/lQ9/0=; b=mVAzFM+x8mYRShAv5GDNj36DZR3pyg/J5d4Sm2HrEqpexI5Slw8TTDjffdZWZqCrt72jjhGvAF+Ij/UiwLwfQEXAJDow76PVfzZJTst8TnCkLWbOxzwEljvByDWpfuq8QEix0GMMOIcrroej9mIgJ4Rqhch+oojec5w6xyi3lFOTBRrSIhKqGN+uqduwrgVubyD2JnTWxr6QgMbiGgWERg/dhCa4sYid0DE56uslywMgBKv2nAcdeSVZgStiam9xPo5xpH+AL+1vdDrq1ClTt0uHUrkKN/7eD/gRTT9u4/3rKBkFwaqDhYd7+9dPbCaPA2QlumkH8qQ15UvsfwKA3g== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.118.233) smtp.rcpttodomain=dpdk.org smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=3627LIotpgp6BILDvCXKuaDznZItiZ4j3jX8U/lQ9/0=; b=KXBiY4YUdXpBzwHuku9OoFCbUHet20IRtSqA0dS+/6YofwqMm9Lz//75HcfUKg3trYsoA/gZgLgUIw88daR9GfdpPmmJ9vE7gW5gAtjTY5AdMthnA2Is68LvEAuqXGlwjn1oKXOOF5qahFPfBm7lNusC3eePD+rtxKtLtck5hZoDD5fTcBcWCkDyECEmY3+QPocTQq49JwhJUVTJz2ipDjrsXbNeryYPP8IBCMnSHCBIQadYLAWvZ1OJ7VNy6U4jlWD5JO6RuuDbOIxEyf82dXgDiHZk4EgM0YTxL0v9mlwC7GjSa0E9usCEtZPBrIbHn6GkGFwt1hvlo+St8yan+g== Received: from BY3PR05CA0005.namprd05.prod.outlook.com (2603:10b6:a03:254::10) by CY8PR12MB7268.namprd12.prod.outlook.com (2603:10b6:930:54::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6411.19; Thu, 18 May 2023 17:40:40 +0000 Received: from CO1PEPF000042AC.namprd03.prod.outlook.com (2603:10b6:a03:254:cafe::8e) by BY3PR05CA0005.outlook.office365.com (2603:10b6:a03:254::10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6433.6 via Frontend Transport; Thu, 18 May 2023 17:40:40 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.118.233) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.118.233 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.118.233; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.118.233) by CO1PEPF000042AC.mail.protection.outlook.com (10.167.243.41) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6411.11 via Frontend Transport; Thu, 18 May 2023 17:40:40 +0000 Received: from drhqmail202.nvidia.com (10.126.190.181) by mail.nvidia.com (10.127.129.6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.5; Thu, 18 May 2023 10:40:24 -0700 Received: from drhqmail202.nvidia.com (10.126.190.181) by drhqmail202.nvidia.com (10.126.190.181) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.37; Thu, 18 May 2023 10:40:23 -0700 Received: from nvidia.com (10.127.8.13) by mail.nvidia.com (10.126.190.181) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.37 via Frontend Transport; Thu, 18 May 2023 10:40:21 -0700 From: Michael Baum To: CC: Ori Kam , Aman Singh , "Yuying Zhang" , Ferruh Yigit , "Thomas Monjalon" , , Subject: [PATCH v2 1/5] doc: fix blank lines in modify field action description Date: Thu, 18 May 2023 20:40:11 +0300 Message-ID: <20230518174015.3373185-2-michaelba@nvidia.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230518174015.3373185-1-michaelba@nvidia.com> References: <20230516063747.3047758-1-michaelba@nvidia.com> <20230518174015.3373185-1-michaelba@nvidia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CO1PEPF000042AC:EE_|CY8PR12MB7268:EE_ X-MS-Office365-Filtering-Correlation-Id: f7c232d2-6e37-48de-6c7b-08db57c6ff85 X-LD-Processed: 43083d15-7273-40c1-b7db-39efd9ccc17a,ExtAddr X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: vSdxdgajGhktMPqIoEqvK8BdGP6YMgdpT5TRPIEI9gCMQQfsbeaGfvy6fjmnFFoA7OSUdQJmOfT4Pd2AWz8IDjngdfV8h99KKMjG/rG/1ncjMCTa6C6xDCQAAi4BBOEd33uxXx29jomclIQK8CWnbCZ590dnWrSjqTIq62zNcASMGDM+sJRHn6U+hFGfaOVH2exnRXlGG4U96r2qK+PV3JVYesGItk73LGNoLPtZ3P/0KVnvcEemwYtmYeSMXgZu3g3u48I6Bp9FvIrPs+6rnZCxnvGOP3EM279qq4WbL/XQM0eiIonqN7KaXER1FNDmzMggxltmiJhasfd4L9gXrHwlzIEVjHym4kF2hOKDp+87R4o3M47lzZ0uRdmq2Op2T+KpGhIkB6i88auZU1cwaAFym7W5iBsGP2vpnK+vvyHal2N7FEqcUI1MNJjtSNJwbCCcatkmOOMVPZa+bDVy8jyPgHZqH5aoNib3N0fPHSMJloXTF0GRvKbddc1pcRzzVtwA5/CchOh2zGV/99ke865fxqrd7Cnfms+dtvaX7EMBg+5HDfBw+r+qfAX1a5WRQinHzD2obpLiUSnmvVe5efujRgJadz9LoWyYsPeHXluDkoT/3WntS7cybbqqnCKlTBebYI04gz+h2Xn+pFV3dhCmMagcOlyBUg8+xgkD4A+NgI6snodG6n9CZD3d5bwnIvmF8rsCQv2G2zXr5yypH8MMrtlJmGtTKTOtnI2howg= X-Forefront-Antispam-Report: CIP:216.228.118.233; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc7edge2.nvidia.com; CAT:NONE; SFS:(13230028)(4636009)(136003)(39860400002)(346002)(396003)(376002)(451199021)(40470700004)(46966006)(36840700001)(2906002)(478600001)(41300700001)(8676002)(316002)(8936002)(54906003)(7696005)(6666004)(70586007)(70206006)(5660300002)(4326008)(6916009)(1076003)(26005)(40460700003)(186003)(6286002)(356005)(55016003)(82740400003)(83380400001)(426003)(36756003)(40480700001)(47076005)(36860700001)(336012)(7636003)(86362001)(82310400005)(2616005); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 May 2023 17:40:40.4038 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: f7c232d2-6e37-48de-6c7b-08db57c6ff85 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.118.233]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: CO1PEPF000042AC.namprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY8PR12MB7268 X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org The modify field action description inside "Generic flow API (rte_flow)" documentation, lists all operations supported for a destination field. In addition, it lists the values supported for a encapsulation level field. Before the lists, in both cases, miss a blank line causing them to look regular text lines. This patch adds the blank lines. Fixes: 73b68f4c54a0 ("ethdev: introduce generic modify flow action") Cc: akozyrev@nvidia.com Cc: stable@dpdk.org Signed-off-by: Michael Baum --- doc/guides/prog_guide/rte_flow.rst | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index 32fc45516a..e7faa368a1 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2917,20 +2917,23 @@ The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it ``RTE_FLOW_FIELD_START`` is used to point to the beginning of a packet. See ``enum rte_flow_field_id`` for the list of supported fields. -``op`` selects the operation to perform on a destination field. +``op`` selects the operation to perform on a destination field: + - ``set`` copies the data from ``src`` field to ``dst`` field. - ``add`` adds together ``dst`` and ``src`` and stores the result into ``dst``. -- ``sub`` subtracts ``src`` from ``dst`` and stores the result into ``dst`` +- ``sub`` subtracts ``src`` from ``dst`` and stores the result into ``dst``. ``width`` defines a number of bits to use from ``src`` field. ``level`` is used to access any packet field on any encapsulation level -as well as any tag element in the tag array. -- ``0`` means the default behaviour. Depending on the packet type, it can -mean outermost, innermost or anything in between. +as well as any tag element in the tag array: + +- ``0`` means the default behaviour. Depending on the packet type, + it can mean outermost, innermost or anything in between. - ``1`` requests access to the outermost packet encapsulation level. - ``2`` and subsequent values requests access to the specified packet -encapsulation level, from outermost to innermost (lower to higher values). + encapsulation level, from outermost to innermost (lower to higher values). + For the tag array (in case of multiple tags are supported and present) ``level`` translates directly into the array index. -- 2.25.1