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 5FBF542B1F for ; Tue, 16 May 2023 08:38:01 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 48A6B42D3A; Tue, 16 May 2023 08:38:01 +0200 (CEST) Received: from NAM11-CO1-obe.outbound.protection.outlook.com (mail-co1nam11on2052.outbound.protection.outlook.com [40.107.220.52]) by mails.dpdk.org (Postfix) with ESMTP id 1BF8442D39; Tue, 16 May 2023 08:38:00 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=H/RRfP7fM9Kpa3Y+ygXbXy/2T+I46KZq7J/v6kcs7Lm4IqIW6lmnz0C7qmzQjjID9xJ8XGdHzm3BGWOjWIW9Op96lsJwuCyVnDyha6NzH9sHepvgCAAJQaojIZX7JsnSTySJDA+7WIXidPShxVASq9z5jFyWIDyjcMAr42ptTjBS5D81KotUrG+OkEo3wx80Z9OOu/Fg5mqHN3d+vrO7uWMucpeznXgbzaQSEU8fgtRCjo6l9voQP5Bzn74sKmuwrff3guAdWvNJgOgSdWSjiOC/+GeCOnHTtguTUferxjdwOQpbFNfHf3w9obMNgnYNG3ulH5uGtChB5AvJdXZ5wA== 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=AGNUWTRE6WSC3i7MRCEZ5l0eKPcie66xJqzdPvlRCGrzfPuQNneW5t8L4sN6vBI0gdh24EaKgSH5aQXWm7Vc7K5cQEoglaS1yCDGh4rYiSAWqJ9qepaGAtUNsQpI5RhvG2Q7I51vSF9YzSJjNmyD5yMPs+rBxR8UyujaqmtEi+6t9vJfIFKX8JQD8WxBHgXzwnczs3aK6N6/j0PnBlNSKqb+3SUS79UkWMn3RGyoP4ryfcShGVwn5mvRVu5Xn4Vz/DVWSaEnen+Uz/pW1QtTWkNgQRbSSjvzB9VqfDPAoMb0jFBSi9gQTtfowHpkz6GOyJnNSw++FaMiuGNtSI3yzQ== 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=PAr5QTpul6ms2kk1dKFw86JJHJCviza9GXE9GP1yIfStMR3azb+mRybz+0zRoy06BuTtNz3NUa9LuXX9rVyj9wuuQKVoGLmvhANRy168VXPZ2LGDHyXMWU34qLWY0ITy8M3E6ccF71XUfezz846xEeEOVHquNzxHUTuaBdqR3MsvL2s3ZO/qmxadUJdbw+/dewE5alCc+ixcj1naMH9UU5N5PV5l4WFZaI2hG1kOKMc+7MiQ3utNW604b/8iIgHWb4uHb/T11qG36zVLKk6j++jI1CAupJsayk+rtyJSeXU6OzOYIR2QJRlxaik1brlLRG2Lto14cn9bL0K9sPP56w== Received: from DM6PR05CA0053.namprd05.prod.outlook.com (2603:10b6:5:335::22) by LV8PR12MB9109.namprd12.prod.outlook.com (2603:10b6:408:18a::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6387.30; Tue, 16 May 2023 06:37:58 +0000 Received: from DS1PEPF0000E644.namprd02.prod.outlook.com (2603:10b6:5:335:cafe::d5) by DM6PR05CA0053.outlook.office365.com (2603:10b6:5:335::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6411.14 via Frontend Transport; Tue, 16 May 2023 06:37:57 +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 DS1PEPF0000E644.mail.protection.outlook.com (10.167.17.200) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6411.11 via Frontend Transport; Tue, 16 May 2023 06:37:57 +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, 15 May 2023 23:37:56 -0700 Received: from drhqmail202.nvidia.com (10.126.190.181) 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, 15 May 2023 23:37:56 -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; Mon, 15 May 2023 23:37:54 -0700 From: Michael Baum To: CC: Ori Kam , Aman Singh , "Yuying Zhang" , Ferruh Yigit , "Thomas Monjalon" , , Subject: [PATCH v1 1/7] doc: fix blank lines in modify field action description Date: Tue, 16 May 2023 09:37:41 +0300 Message-ID: <20230516063747.3047758-2-michaelba@nvidia.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230516063747.3047758-1-michaelba@nvidia.com> References: <20230516063747.3047758-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: DS1PEPF0000E644:EE_|LV8PR12MB9109:EE_ X-MS-Office365-Filtering-Correlation-Id: abec1f8a-9831-4e89-9a3c-08db55d81635 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: Ejvw639fQvrjpLrCLrKWt1uEMdLhwEXBMjXUL1eh8WPJGNxyLoClFhLKGoMfn8uUTmVOToYKXIyBKboPkLICCAa3wMkuQcl+liqTGbzQibQZQxT2dgSxVIBMTgNTnqh5x+4whs3yLQv4mDX4RKq7cZMAvRkCO5nLnYLaM4hkXifeamFoH9NOzK1QZ+v2xa3EtewofzOcUQPU048fgRzVJxNQreL5QmWzljv1DuJVHL+X0vw3mj13nMlsjKuOHf8EmGjpLm15t85XEQGbyd2NjcGA/L0VK0YfXXGQtU1mBt4rvFIVZ/oRqTYW11PvFHygIah9zaM63OGK5StH5lDDXs9OCuFz5Cig42Bd8RCfe/EtHA73VCMpS4jWsOOxwm0uITFtdmoNdmgGmdZxTABesYBIoV//0d21/N71lsQDoeBIqcjU2Y83eNGDMtbgUy8LgKvfHxvJi6IxAuX/ckw+8RUDSR64GkAZZSIZITnmEMsJP4VCMsonK6s0LT5p+n7rHQgKd82AxCH/9nAaHXyJbZjjnr/dqDCKEMQBXOmvAuJkJYI1qwVkyPykXmJ5qbghDu2rE1uJ9BEDahsMKsYML68pKys+4W3vw2gGKhcY2xeP7XvjhEvWzmESRhkUkYGGDEdBKSbh84gv7D7zyL6w3XgvJGIa2Jm20uwQJpywcwAxQ+ULXALkEglKkUooM0wKqJX39sfWO0h2xIONkSFFYVnp0w1nn7V/ytlTRIXnquA= 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)(346002)(136003)(396003)(39860400002)(376002)(451199021)(46966006)(40470700004)(36840700001)(40480700001)(7636003)(86362001)(40460700003)(478600001)(54906003)(82310400005)(55016003)(7696005)(6666004)(36756003)(356005)(186003)(26005)(1076003)(6286002)(5660300002)(70206006)(70586007)(2906002)(83380400001)(6916009)(4326008)(316002)(82740400003)(8936002)(8676002)(426003)(336012)(2616005)(41300700001)(36860700001)(47076005); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 May 2023 06:37:57.5559 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: abec1f8a-9831-4e89-9a3c-08db55d81635 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: DS1PEPF0000E644.namprd02.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: LV8PR12MB9109 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