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 A187C42B73 for ; Tue, 23 May 2023 23:32:21 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 96FD642D32; Tue, 23 May 2023 23:32:21 +0200 (CEST) Received: from NAM10-MW2-obe.outbound.protection.outlook.com (mail-mw2nam10on2044.outbound.protection.outlook.com [40.107.94.44]) by mails.dpdk.org (Postfix) with ESMTP id 82A9E42BDA; Tue, 23 May 2023 23:32:19 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=QG0yuxDfzY6ZyWWCGXe5Bts6h1Mm4Au+jttEA4BGJfGKBnOUaHOJBwzciydZbZ83OIwkjccsabrDEKqyla79sBdUWLR0BP/7jmNmtUsdYGpB18Y20f943GQkyFlYM0Or55gHv3lwtN1cMw4IvfMiFylfeI6NQz6MJ9E6btfYVHVzKEgjU3iiYHT8yAWw2BGYlFsdEIq1hOd1M7VRbrrIjDYlEVUu/qlz4jHAnIqwZJ8zl/SOV2cowIliTiDBDf7fCR/Is42wcf/+U5FdqEZ84bCL2LGH094uSaXAJprWFcD3+BGfAKIl/75BtGMWtsTSVlcGUOTbhLWfA0hwqNa/9Q== 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=aLLPZxlXTjZOlnOoknUJLOI7tF1Pdm7QWMoETvNdNdg=; b=RukkiO6ykCepH13xop19TkIi4YvlIMzqjzPH2J74S1JgAsTMiFX0Mxo74xV1AXTCb57rWcE5dKUH309UjceDHnZl9pMeM27wVu9xtxazAPAsovHIJ0m2kG3LCsw+9wHXrcjSrsZJZzdBXq/xv8Sc4oGnUHvVBSAxuBZRSymUQPYJv4LgajsPg/u8eOwNntud/RjBXXqcO8VF/2a0YhoxUpnZVFv1dwssdfeGgTLIM3yKKBZAXHyDBx+uvUzCkjiX49e+f2TZ79NuxoSjFJHwmzC7AssTtUS6p5QapUvF09X94lYqMu1gYd/EYeZJXicqy76wOjeLVBmHnLJ28B8q6w== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.117.160) 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=aLLPZxlXTjZOlnOoknUJLOI7tF1Pdm7QWMoETvNdNdg=; b=dxr6A0xvJvMcjIq/IB1QKU0g0LUO1GHBKDVIWIeSNMWWs+EUTD83GXAduDBxC7okPmORe1ZBTUCHvcy5U0y59x0YiFsM5bBQ6Ns/nbtOSypURP4BMGGGJtEnBU+qCH2S8Sg87btc0r5jmNyZqdAt0DF6k0BHK1G6S/mWl6XiPF6DezrczZFj6BPMq/1761F0JtDhzMm87mR4/x5PBjz43+r7MfgaE78p53Op9UoYf9RmUIwOkhWfLjbqjPazEgnVomFUA8vv5v9G08naO8G0dxsqA5uJFalFgnmBd9G8Wi5BgP1fRBYnzAfPpXM1tN81yrLBBfexbkazRxXhRQodhA== Received: from DS7PR05CA0009.namprd05.prod.outlook.com (2603:10b6:5:3b9::14) by MN0PR12MB6054.namprd12.prod.outlook.com (2603:10b6:208:3ce::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6411.28; Tue, 23 May 2023 21:32:17 +0000 Received: from DM6NAM11FT078.eop-nam11.prod.protection.outlook.com (2603:10b6:5:3b9:cafe::84) by DS7PR05CA0009.outlook.office365.com (2603:10b6:5:3b9::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6433.14 via Frontend Transport; Tue, 23 May 2023 21:32:17 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.160) 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.117.160 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.117.160; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.117.160) by DM6NAM11FT078.mail.protection.outlook.com (10.13.173.183) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6411.30 via Frontend Transport; Tue, 23 May 2023 21:32:16 +0000 Received: from rnnvmail204.nvidia.com (10.129.68.6) by mail.nvidia.com (10.129.200.66) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.5; Tue, 23 May 2023 14:32:07 -0700 Received: from rnnvmail202.nvidia.com (10.129.68.7) by rnnvmail204.nvidia.com (10.129.68.6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.37; Tue, 23 May 2023 14:32:06 -0700 Received: from nvidia.com (10.127.8.13) by mail.nvidia.com (10.129.68.7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.37 via Frontend Transport; Tue, 23 May 2023 14:32:04 -0700 From: Michael Baum To: CC: Ori Kam , Aman Singh , "Yuying Zhang" , Ferruh Yigit , "Thomas Monjalon" , , Subject: [PATCH v5 1/5] doc: fix blank lines in modify field action description Date: Wed, 24 May 2023 00:31:53 +0300 Message-ID: <20230523213157.3905696-2-michaelba@nvidia.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230523213157.3905696-1-michaelba@nvidia.com> References: <20230523124805.3846360-1-michaelba@nvidia.com> <20230523213157.3905696-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: DM6NAM11FT078:EE_|MN0PR12MB6054:EE_ X-MS-Office365-Filtering-Correlation-Id: 6eb06273-7b69-42df-157e-08db5bd52e96 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: rL6WWF3z+xP/24myu7yObdWCpXjKi1IJflSptz3U0FGrjJItYAbc+MdBknrvdtvAPxWETuKJ3QtVJkTFLB4jYnWSuVxssy7+atWRHUDIfmkF/5EEVQm9B5Ck9p4/4dad6rKjUi9ryDn1VFu3pr65VBf32wAyrFRINl5zA+jn8Dg/ze20aV5S435T0u3xfJrkut81GpCzEPLISSHZWfAUFWo4enTYBetIy2ZekKxwNTXiSn7j+HmmPDCgAP1OlppYzsF2Fc4AQ/IkXrGMqHI0Zi2+FBGbWpSYcCnLni2pjY6ogHxcnvNtBouj9KovOS4A+hqLBc8WhecqDq+kbw8G7qK55UT4yz+cccSHlAAU7B3WISCFMVl0EXxyz4Ekp+YkBpq7hvThT4eWdbwLh8edfs/+SBiRZfKeCkNqMszoJeY+wj1CMVefuvvk3m2neMH3U0/WgRQptrxk9IasUWvZWPrC7fPihyLScFPzXGda48JEbM9b27DZXeqohFt3fhPhyrg84ESiORU8GZapbJ+Slt+BJX2SIsw5mHjzEi238sUe6nenGsaYJuTpCQJOGsc1CeHUssptJ140S9sBzM1GWhkieq26rSYHnf8xnJgtGdlJjRCrESMEWvWQAbNWqwhTmMRAYhVC/ri2HIkUzDufJ3bXisOLeWmtmQAph924XGXsTFHa60/2TZ8Lkj+7FPTU3/qYHvqsbkfnwH5c7/tx8iOmopmVhqxDbapAUicSe1A= X-Forefront-Antispam-Report: CIP:216.228.117.160; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge1.nvidia.com; CAT:NONE; SFS:(13230028)(4636009)(39860400002)(346002)(376002)(396003)(136003)(451199021)(36840700001)(40470700004)(46966006)(2906002)(8936002)(83380400001)(5660300002)(8676002)(70586007)(82310400005)(70206006)(6666004)(6916009)(4326008)(36756003)(54906003)(316002)(7696005)(478600001)(55016003)(40480700001)(41300700001)(426003)(86362001)(356005)(26005)(2616005)(7636003)(1076003)(82740400003)(47076005)(336012)(186003)(36860700001)(6286002)(40460700003); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 May 2023 21:32:16.9400 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 6eb06273-7b69-42df-157e-08db5bd52e96 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.117.160]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: DM6NAM11FT078.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN0PR12MB6054 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 Acked-by: Ori Kam --- 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