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 56AF642B76 for ; Mon, 22 May 2023 21:28:28 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C79C1427EE; Mon, 22 May 2023 21:28:26 +0200 (CEST) Received: from NAM04-BN8-obe.outbound.protection.outlook.com (mail-bn8nam04on2070.outbound.protection.outlook.com [40.107.100.70]) by mails.dpdk.org (Postfix) with ESMTP id 1CB0D410F2; Mon, 22 May 2023 21:28:25 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=P+O9hUTB+rzfS451T/HSN5atnIU/vPahRQ1PEaOkudqT88Zafox4vsWi1ow9ItKY7gviuHqgG6qb5kTO6vZEetbduSN4X5VMNhpMRB1dNSSkr1g5mhVm49empol3PDPuMr1SWQBLWlPIspUJOJCHxZI4lgScEN5PgJ4VUVWi3wDl6jTftgOZSL+mx7Vrs1mb/lK4Lh5i9i3ZaGFGUJkfbsZUasIOQ0nGhZnRpMfVjIte1FHs84dM/QETlzOKxQZ2Fjc7oD0lEa5lWBh4XT/4LWsOK7wlIWmGcBjkLR1fb9SWe2xOh9VdICTHn5Z410x3XYvLCqQcQB+AcoCZk1AoAg== 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=PRSO7tEvMwBh5iWEruuS+/beESa+JRjvPnEpX1fI1N0xmvl4d9VabzcAKE7aDqM5RC2Il8/mlrYW8JaezV9aO8aaIVLmWeNNZhcvcEnrOESZ87djLQ/ee9G59mC3zdMYhwaDfhU51fstFOoWIbLUTlLB/mjwCBnnRuxXedz/VCejXs/BSbuy3QM0vjr1an/Lt53NFOnl/wuoEjbkX+LOZkdpf9q57BpaexnCysV08Fcx0BDguA2gWvgzy1h4sqIG/F9I+JjtikgeIqFJImU/77c8UpQRsWeAr2+Ia7TeaQ1EAm/rVrluGjYV02qBiZDYtLVqr6BxWjU/vl6r0+Ly/Q== 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=ezqSlwtpnG8YAOzhRvBbkNFLNlkkm5AiyPM62Jt9hKJyUL8qWM6IRs+ihCQ5NigAvQdrWsROHhTGxfQpF0g2NA2Tqtc275EvOAETZ82XilXUmUcNw696lXXIQEceWhNwxlkk6Y8oT/J/w6qF6In0oj9R1kB+X6qn3MuyZoB6iVdKt/QeRM/aEMnJQuYv7+1dMAhZlqBoiIl1AJZbkLB4Gm7iSRSkUE2ih6Acjdux7gKrI5UYLGZ9jpm5kI69YPX++6LW5R3oGBaEESc3g3V1hw25x2ofPiLkvyKdz2b6tm6WGLV6ANsl9Ezo67/9QVcr83Ml9tUywavN9eEJaQkWIg== Received: from BYAPR07CA0074.namprd07.prod.outlook.com (2603:10b6:a03:12b::15) by PH7PR12MB9149.namprd12.prod.outlook.com (2603:10b6:510:2ea::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6411.28; Mon, 22 May 2023 19:28:23 +0000 Received: from DM6NAM11FT005.eop-nam11.prod.protection.outlook.com (2603:10b6:a03:12b:cafe::40) by BYAPR07CA0074.outlook.office365.com (2603:10b6:a03:12b::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6411.28 via Frontend Transport; Mon, 22 May 2023 19:28:23 +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 DM6NAM11FT005.mail.protection.outlook.com (10.13.172.238) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6411.28 via Frontend Transport; Mon, 22 May 2023 19:28:22 +0000 Received: from drhqmail201.nvidia.com (10.126.190.180) 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; Mon, 22 May 2023 12:28:12 -0700 Received: from drhqmail203.nvidia.com (10.126.190.182) by drhqmail201.nvidia.com (10.126.190.180) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.37; Mon, 22 May 2023 12:28:12 -0700 Received: from nvidia.com (10.127.8.13) by mail.nvidia.com (10.126.190.182) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.37 via Frontend Transport; Mon, 22 May 2023 12:28:10 -0700 From: Michael Baum To: CC: Ori Kam , Aman Singh , "Yuying Zhang" , Ferruh Yigit , "Thomas Monjalon" , , Subject: [PATCH v3 1/5] doc: fix blank lines in modify field action description Date: Mon, 22 May 2023 22:28:00 +0300 Message-ID: <20230522192804.3759072-2-michaelba@nvidia.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230522192804.3759072-1-michaelba@nvidia.com> References: <20230518174015.3373185-1-michaelba@nvidia.com> <20230522192804.3759072-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: DM6NAM11FT005:EE_|PH7PR12MB9149:EE_ X-MS-Office365-Filtering-Correlation-Id: 25d69e0f-13b0-4242-dd20-08db5afab4fe 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: lL1i+DxTYNEwpxSxscq95mtraPsU46udmLgezZjJHJhG0rqAJp0vXVP+pdxrBT7VDuBCaggf2VKQdbCzKoHK++/IMJ8RM97wsxF+zO58rQo9vVV5aNitLurZo3YIIz4sQjMcs5j3TEMRUfzoc3IIczKG6MwJzqi6k/dDzZ6Zu/iUCaWexSwZJSWDIqTDYFXULfTPyZqloVi8qhyR/cenugQTU5Mi+C6xDcNjDMkjj/VBhUUXlTRnjvuCFKkfpjflMQPF3LAVsdgy4v+e0romOeQXfzN7tilW9ZG/+yNtHcjaJZPdY0uNeEY4jwEzJnMNhpVmEbkKLuBBNceuUZgvQLyep0vFhX4mpzZou4LhaAhM+TgyBE6qSjGMtIb/igJpRqTkbBEzAERRDgPpw3ynfipJPArtGZL4YodvmmEg4gJD6+AfLsTn/LkZoaRrfdhW6HgDEDuNYSIbPPBNHSg10LEs7HPGhNK6wuSQHihP3CfHs8RweA5OdJW5TU0FzjILjswSFIIUyMwFesQCqF9ngXdf33pc0+9RWPEJzLub8hD0qVhKHKKw7C0YQh5j2rWA1NzIbpk4O+j2uFInJ4PoKjFQ3LILEMRhpD6xlhlXRyFXSdAIKEl0BKpadAJOKkkyyk9GRan2yHOPp+NRr8PCxa5S/obql41UWrHdCfU0gIWwJBzABlqpIvQWhYiYRgJsYtAZDidn11Yd5QLrdqwYgJuABywUJi6SIsnF5fobHOk= 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)(376002)(39860400002)(396003)(136003)(346002)(451199021)(40470700004)(36840700001)(46966006)(7636003)(356005)(8936002)(8676002)(82740400003)(40460700003)(5660300002)(47076005)(40480700001)(55016003)(26005)(1076003)(186003)(2906002)(6286002)(2616005)(36756003)(336012)(426003)(83380400001)(82310400005)(36860700001)(86362001)(54906003)(316002)(6666004)(6916009)(4326008)(478600001)(70206006)(70586007)(41300700001)(7696005); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 May 2023 19:28:22.6732 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 25d69e0f-13b0-4242-dd20-08db5afab4fe 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: DM6NAM11FT005.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR12MB9149 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