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 2896F42B81 for ; Tue, 23 May 2023 14:48:33 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1C73042D40; Tue, 23 May 2023 14:48:33 +0200 (CEST) Received: from NAM12-BN8-obe.outbound.protection.outlook.com (mail-bn8nam12on2089.outbound.protection.outlook.com [40.107.237.89]) by mails.dpdk.org (Postfix) with ESMTP id 38A934282D; Tue, 23 May 2023 14:48:32 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=VSNdpASff4xehPy2L7UBPAz1eg5hwrjqKk5x/3If+gEuTxrRHg1Jo76SIK6YQAlyn8IUobxJ6xa23ZdcfF/MfPM1iv3J2DwWM9ntphDijcpQINxrGGyAwdlH2SffQ7/wPxVSpsLz7hM/B30tgM19NctqHfAGYsmOto+iUOQhYTANMWsStTv0H0pxP6IKoL5omiAHxw0FtNuX/vgRxKDqj/E1outIE9q2VR657bbLtqiuBlFi8odRKK9TTVMFBfLKdOc0SZwXiIia8y5AV83YjfaDK0o4AUAlqbCcak0mrjZjfSn+X2i+VwwHYoWLFxtID8uQjbjxto3AacXwYgyC8Q== 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=Fx+SzMKPuI2MDzcDxSO+FTzS1fLZ7oiUKKm9prkL1l/a6lR7PFrEIUxL4hkf2oisQN65kRIcChbq16HDcSDq8O9eCwNe+LyqlEpz+bn2o9NEWFAxbRWU7zappLOKtxjwTuyx4pQ/wEzkViNx+5+aCSnWFpuRV9rHrU3lflaUtqWrRbWtkOQiAhNxjBb+w5Hd/q9vMgBQaZgbyIwR1uwmT+bRbeFjZY2YlY+/xZ6m35+6YOMMj/Kh8c3KLAmcFsO/FP54cJe3TAG3TKYQcBeHqt418ZfSxXJ9BnB9wc9L1hBUUs2P+S5Yaqbf2ZxqPIRXJX65vAVZi/NJRQbr5M/mOg== 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=PfWjcNn6Zg5uSCreKIH5gxYhCzaFO/8R/87I1GrFA88m3noBndf+ow4qUAnc7sktZr5+pCWjs49F0wQr+7/ZuXvan9tu0ZSAFaTigdAvPh69SVQHlDetUPWfNsCwQUDsBADDLXHKH4BuVcKuFMGBSCxrYgqj1U/6otimYI6lS5KgPB8JvZLz4Rz/r9lqBNwmP8CkozDJN6WD/f2TPX+LBYh1rdp+o39d40nI0Bpt/Va+5K6sYuAUSvMx32yJcD/hmZ+EKvRqm8ipOhnqHx19yGyqvSaf/pijiVx3/uGR829dYju/nFlJOEWeEqWwP7lPK5pvjwj+m3/jhkZlF/D0RA== Received: from CY5PR22CA0089.namprd22.prod.outlook.com (2603:10b6:930:65::20) by SA1PR12MB6704.namprd12.prod.outlook.com (2603:10b6:806:254::6) 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 12:48:30 +0000 Received: from CY4PEPF0000C96B.namprd02.prod.outlook.com (2603:10b6:930:65:cafe::5b) by CY5PR22CA0089.outlook.office365.com (2603:10b6:930:65::20) 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 12:48:30 +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 CY4PEPF0000C96B.mail.protection.outlook.com (10.167.241.75) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6433.7 via Frontend Transport; Tue, 23 May 2023 12:48:30 +0000 Received: from rnnvmail203.nvidia.com (10.129.68.9) 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 05:48:15 -0700 Received: from rnnvmail203.nvidia.com (10.129.68.9) by rnnvmail203.nvidia.com (10.129.68.9) 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 05:48:14 -0700 Received: from nvidia.com (10.127.8.13) by mail.nvidia.com (10.129.68.9) 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 05:48:12 -0700 From: Michael Baum To: CC: Ori Kam , Aman Singh , "Yuying Zhang" , Ferruh Yigit , "Thomas Monjalon" , , Subject: [PATCH v4 1/5] doc: fix blank lines in modify field action description Date: Tue, 23 May 2023 15:48:01 +0300 Message-ID: <20230523124805.3846360-2-michaelba@nvidia.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230523124805.3846360-1-michaelba@nvidia.com> References: <20230522192804.3759072-1-michaelba@nvidia.com> <20230523124805.3846360-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: CY4PEPF0000C96B:EE_|SA1PR12MB6704:EE_ X-MS-Office365-Filtering-Correlation-Id: 2ec70a22-09aa-4410-00bc-08db5b8c02a9 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: 6cELoMzt4+E1V5JorVPufyQahmCDXzrqedRX1UFotBNec4PGT9MrlyjN/C70nHTKQlHy/xHFBMgqhwuNpFc2Uylw/8CSpnfEqEtWZjViwo9Pt1wQ/7T8dEV0EP98+h06TFn/EwFDY9XeECxvpBSuJ/XwiiSfexv3Qg/DNMPFzJNbx7W1FSW1HtDQmw0VVgueUH1KjZYl5E1ZmMv2nfzmHmyuQN92zuikMTJE1oQMfIyM1uSUsU5YBIQGKh2zvsgLriAUF9pQm9/z/2kC7Cz5kV7IgdsMfVtENjGxLPfo2zPetp1oh5nqROQbWdX0czUjNeFhk3CNOhX6W5kbU0nX6Ev3f3BWXJVncL7+jNTUdI3b0LQGMn4fuAMD6bWbz5NUKFbQQ7TrutiiYOLnobBa9RYDIkrPGiE4BZKNAnIUS52cE/QEpQuf1T7EUuuIMh65tuBBmh9kcbDmOgT760rsTpmQt/wfRkCORqdcKq48iicZoiKwyUbJgQZdgW4wP6v8djIsTDjTtbPxhessGs0nsZHVsdzcTBUslX8QyopKL5cmNxF/ka6fXeRwShbKUKA8TgRquLO8pqL/2qVolHiLwtkvV2wzQHGF9U7CDb3MfDkJ92ds2By4+cqu6w2bqajZuy+xDKudH7hLn3DfOhtR9wH9MKn59xtXo6FBjvHov9sVlFdptz1HEr5i8juOgcg+NcLTNUvukxMIUv8Rhr4WncpwBOunC5kk32Mw6D7f1GE= 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)(346002)(136003)(39860400002)(376002)(396003)(451199021)(40470700004)(36840700001)(46966006)(316002)(4326008)(6916009)(70206006)(70586007)(426003)(336012)(478600001)(82310400005)(54906003)(8676002)(8936002)(7696005)(86362001)(6666004)(41300700001)(5660300002)(26005)(36756003)(36860700001)(82740400003)(83380400001)(7636003)(1076003)(356005)(47076005)(55016003)(6286002)(186003)(40460700003)(2906002)(2616005)(40480700001); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 May 2023 12:48:30.0142 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 2ec70a22-09aa-4410-00bc-08db5b8c02a9 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: CY4PEPF0000C96B.namprd02.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA1PR12MB6704 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