Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/104578/?format=api
{ "id": 104578, "url": "http://patchwork.dpdk.org/api/patches/104578/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20211122170059.4115953-1-john.mcnamara@intel.com/", "project": { "id": 1, "url": "http://patchwork.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20211122170059.4115953-1-john.mcnamara@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20211122170059.4115953-1-john.mcnamara@intel.com", "date": "2021-11-22T17:00:59", "name": "[v1] doc: update release notes for 21.11", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "59cda08dcad02f94aac24d9957e48a0e225898e0", "submitter": { "id": 154, "url": "http://patchwork.dpdk.org/api/people/154/?format=api", "name": "John McNamara", "email": "john.mcnamara@intel.com" }, "delegate": { "id": 24651, "url": "http://patchwork.dpdk.org/api/users/24651/?format=api", "username": "dmarchand", "first_name": "David", "last_name": "Marchand", "email": "david.marchand@redhat.com" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20211122170059.4115953-1-john.mcnamara@intel.com/mbox/", "series": [ { "id": 20691, "url": "http://patchwork.dpdk.org/api/series/20691/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=20691", "date": "2021-11-22T17:00:59", "name": "[v1] doc: update release notes for 21.11", "version": 1, "mbox": "http://patchwork.dpdk.org/series/20691/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/104578/comments/", "check": "fail", "checks": "http://patchwork.dpdk.org/api/patches/104578/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 738E8A0C4B;\n\tMon, 22 Nov 2021 18:01:09 +0100 (CET)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 3A1734014E;\n\tMon, 22 Nov 2021 18:01:09 +0100 (CET)", "from mga07.intel.com (mga07.intel.com [134.134.136.100])\n by mails.dpdk.org (Postfix) with ESMTP id 364ED4003C\n for <dev@dpdk.org>; Mon, 22 Nov 2021 18:01:07 +0100 (CET)", "from orsmga006.jf.intel.com ([10.7.209.51])\n by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 22 Nov 2021 09:01:05 -0800", "from silpixa00389815.ir.intel.com (HELO\n silpixa00389815.ger.corp.intel.com) ([10.237.223.46])\n by orsmga006.jf.intel.com with ESMTP; 22 Nov 2021 09:01:04 -0800" ], "X-IronPort-AV": [ "E=McAfee;i=\"6200,9189,10176\"; a=\"298239539\"", "E=Sophos;i=\"5.87,255,1631602800\"; d=\"scan'208\";a=\"298239539\"", "E=Sophos;i=\"5.87,255,1631602800\"; d=\"scan'208\";a=\"456704914\"" ], "X-ExtLoop1": "1", "From": "John McNamara <john.mcnamara@intel.com>", "To": "dev@dpdk.org", "Cc": "thomas@monjalon.net,\n\tJohn McNamara <john.mcnamara@intel.com>", "Subject": "[PATCH v1] doc: update release notes for 21.11", "Date": "Mon, 22 Nov 2021 17:00:59 +0000", "Message-Id": "<20211122170059.4115953-1-john.mcnamara@intel.com>", "X-Mailer": "git-send-email 2.25.1", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Fix grammar, spelling and formatting of DPDK 21.11 release notes.\n\nSigned-off-by: John McNamara <john.mcnamara@intel.com>\n---\n doc/guides/rel_notes/release_21_11.rst | 123 +++++++++++++------------\n 1 file changed, 65 insertions(+), 58 deletions(-)", "diff": "diff --git a/doc/guides/rel_notes/release_21_11.rst b/doc/guides/rel_notes/release_21_11.rst\nindex 4d8c59472a..7008c5e907 100644\n--- a/doc/guides/rel_notes/release_21_11.rst\n+++ b/doc/guides/rel_notes/release_21_11.rst\n@@ -57,14 +57,14 @@ New Features\n \n * **Enabled new devargs parser.**\n \n- * Enabled devargs syntax\n- ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``\n+ * Enabled devargs syntax:\n+ ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``.\n * Added bus-level parsing of the devargs syntax.\n * Kept compatibility with the legacy syntax as parsing fallback.\n \n * **Updated EAL hugetlbfs mount handling for Linux.**\n \n- * Modified to allow ``--huge-dir`` option to specify a sub-directory\n+ * Modified EAL to allow ``--huge-dir`` option to specify a sub-directory\n within a hugetlbfs mountpoint.\n \n * **Added dmadev library.**\n@@ -82,7 +82,7 @@ New Features\n \n * **Added IDXD dmadev driver implementation.**\n \n- The IDXD dmadev driver provide device drivers for the Intel DSA devices.\n+ The IDXD dmadev driver provides device drivers for the Intel DSA devices.\n This device driver can be used through the generic dmadev API.\n \n * **Added IOAT dmadev driver implementation.**\n@@ -98,29 +98,34 @@ New Features\n \n * **Added NXP DPAA DMA driver.**\n \n- Added a new dmadev driver for NXP DPAA platform.\n+ Added a new dmadev driver for the NXP DPAA platform.\n \n * **Added support to get all MAC addresses of a device.**\n \n- Added ``rte_eth_macaddrs_get`` to allow user to retrieve all Ethernet\n- addresses assigned to given ethernet port.\n+ Added ``rte_eth_macaddrs_get`` to allow a user to retrieve all Ethernet\n+ addresses assigned to a given Ethernet port.\n \n-* **Introduced GPU device class with first features:**\n+* **Introduced GPU device class.**\n \n- * Device information\n- * Memory management\n- * Communication flag & list\n+ Introduced the GPU device class with initial features:\n+\n+ * Device information.\n+ * Memory management.\n+ * Communication flag and list.\n \n * **Added NVIDIA GPU driver implemented with CUDA library.**\n \n+ Added NVIDIA GPU driver implemented with CUDA library under the new\n+ GPU device interface.\n+\n * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**\n \n- Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and\n- TCP/UDP/SCTP header checksum field can be used as input set for RSS.\n+ Added macros ``ETH_RSS_IPV4_CHKSUM`` and ``ETH_RSS_L4_CHKSUM``. The IPv4 and\n+ TCP/UDP/SCTP header checksum field can now be used as input set for RSS.\n \n * **Added L2TPv2 and PPP protocol support in flow API.**\n \n- Added flow pattern items and header formats of L2TPv2 and PPP protocol.\n+ Added flow pattern items and header formats for the L2TPv2 and PPP protocols.\n \n * **Added flow flex item.**\n \n@@ -146,11 +151,11 @@ New Features\n \n * Added new device capability flag and Rx domain field to switch info.\n * Added share group and share queue ID to Rx queue configuration.\n- * Added testpmd support and dedicate forwarding engine.\n+ * Added testpmd support and dedicated forwarding engine.\n \n * **Updated af_packet ethdev driver.**\n \n- * Default VLAN strip behavior was changed. VLAN tag won't be stripped\n+ * The default VLAN strip behavior has changed. The VLAN tag won't be stripped\n unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.\n \n * **Added API to get device configuration in ethdev.**\n@@ -159,28 +164,30 @@ New Features\n \n * **Updated AF_XDP PMD.**\n \n- * Disabled secondary process support.\n+ * Disabled secondary process support due to insufficient state shared\n+ between processes which causes a crash. This will be fixed/re-enabled\n+ in the next release.\n \n * **Updated Amazon ENA PMD.**\n \n Updated the Amazon ENA PMD. The new driver version (v2.5.0) introduced\n bug fixes and improvements, including:\n \n- * Support for the tx_free_thresh and rx_free_thresh configuration parameters.\n+ * Support for the ``tx_free_thresh`` and ``rx_free_thresh`` configuration parameters.\n * NUMA aware allocations for the queue helper structures.\n- * Watchdog's feature which is checking for missing Tx completions.\n+ * A Watchdog feature which is checking for missing Tx completions.\n \n * **Updated Broadcom bnxt PMD.**\n \n * Added flow offload support for Thor.\n * Added TruFlow and AFM SRAM partitioning support.\n- * Implement support for tunnel offload.\n+ * Implemented support for tunnel offload.\n * Updated HWRM API to version 1.10.2.68.\n- * Added NAT support for dest IP and port combination.\n+ * Added NAT support for destination IP and port combination.\n * Added support for socket redirection.\n * Added wildcard match support for ingress flows.\n * Added support for inner IP header for GRE tunnel flows.\n- * Updated support for RSS action in flow rule.\n+ * Updated support for RSS action in flow rules.\n * Removed devargs option for stats accumulation.\n \n * **Updated Cisco enic driver.**\n@@ -202,9 +209,9 @@ New Features\n \n * Added protocol agnostic flow offloading support in Flow Director.\n * Added protocol agnostic flow offloading support in RSS hash.\n- * Added 1PPS out support by a devargs.\n+ * Added 1PPS out support via devargs.\n * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.\n- * Added DEV_RX_OFFLOAD_TIMESTAMP support.\n+ * Added ``DEV_RX_OFFLOAD_TIMESTAMP`` support.\n * Added timesync API support under scalar path.\n * Added DCF reset API support.\n \n@@ -225,7 +232,7 @@ New Features\n Updated the Mellanox mlx5 driver with new features and improvements, including:\n \n * Added implicit mempool registration to avoid data path hiccups (opt-out).\n- * Added delay drop support for Rx queue.\n+ * Added delay drop support for Rx queues.\n * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).\n * Added socket direct mode bonding support.\n \n@@ -275,7 +282,7 @@ New Features\n Added a new Xilinx vDPA (``sfc_vdpa``) PMD.\n See the :doc:`../vdpadevs/sfc` guide for more details on this driver.\n \n-* **Added telemetry callbacks to cryptodev library.**\n+* **Added telemetry callbacks to the cryptodev library.**\n \n Added telemetry callback functions which allow a list of crypto devices,\n stats for a crypto device, and other device information to be queried.\n@@ -300,7 +307,7 @@ New Features\n \n * **Added support for event crypto adapter on Marvell CN10K and CN9K.**\n \n- * Added event crypto adapter OP_FORWARD mode support.\n+ * Added event crypto adapter ``OP_FORWARD`` mode support.\n \n * **Updated Mellanox mlx5 crypto driver.**\n \n@@ -309,7 +316,7 @@ New Features\n \n * **Updated NXP dpaa_sec crypto PMD.**\n \n- * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.\n+ * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algorithm support.\n * Added PDCP short MAC-I support.\n * Added raw vector datapath API support.\n \n@@ -322,16 +329,16 @@ New Features\n \n * The IPsec_MB framework was added to share common code between Intel\n SW Crypto PMDs that depend on the intel-ipsec-mb library.\n- * Multiprocess support was added for the consolidated PMDs,\n+ * Multiprocess support was added for the consolidated PMDs\n which requires v1.1 of the intel-ipsec-mb library.\n- * The following PMDs were moved into a single source folder,\n- however their usage and EAL options remain unchanged.\n+ * The following PMDs were moved into a single source folder\n+ while their usage and EAL options remain unchanged.\n * AESNI_MB PMD.\n * AESNI_GCM PMD.\n * KASUMI PMD.\n * SNOW3G PMD.\n * ZUC PMD.\n- * CHACHA20_POLY1305 - A new PMD added.\n+ * CHACHA20_POLY1305 - a new PMD.\n \n * **Updated the aesni_mb crypto PMD.**\n \n@@ -381,7 +388,7 @@ New Features\n * **Added multi-process support for testpmd.**\n \n Added command-line options to specify total number of processes and\n- current process ID. Each process owns subset of Rx and Tx queues.\n+ current process ID. Each process owns a subset of Rx and Tx queues.\n \n * **Updated test-crypto-perf application with new cases.**\n \n@@ -404,8 +411,8 @@ New Features\n \n * **Updated l3fwd sample application.**\n \n- * Increased number of routes to 16 for all lookup modes (LPM, EM and FIB),\n- this helps in validating SoC with many ethernet devices.\n+ * Increased number of routes to 16 for all lookup modes (LPM, EM and FIB).\n+ This helps in validating SoC with many Ethernet devices.\n * Updated EM mode to use RFC2544 reserved IP address space with RFC863\n UDP discard protocol.\n \n@@ -431,8 +438,8 @@ New Features\n \n * **Added ASan support.**\n \n- `AddressSanitizer\n- <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_ (ASan)\n+ Added ASan/AddressSanitizer support. `AddressSanitizer\n+ <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_\n is a widely-used debugging tool to detect memory access errors.\n It helps to detect issues like use-after-free, various kinds of buffer\n overruns in C/C++ programs, and other similar errors, as well as\n@@ -454,12 +461,12 @@ Removed Items\n * eal: Removed the deprecated function ``rte_get_master_lcore()``\n and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.\n \n-* eal: The old api arguments that were deprecated for\n+* eal: The old API arguments that were deprecated for\n blacklist/whitelist are removed. Users must use the new\n block/allow list arguments.\n \n * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.\n- ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.\n+ The ``PKT_RX_OUTER_IP_CKSUM_BAD`` flag should be used as a replacement.\n \n * ethdev: Removed the port mirroring API. A more fine-grain flow API\n action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.\n@@ -468,9 +475,9 @@ Removed Items\n ``rte_eth_mirror_rule_reset`` along with the associated macros\n ``ETH_MIRROR_*`` are removed.\n \n-* ethdev: Removed ``rte_eth_rx_descriptor_done`` API function and its\n+* ethdev: Removed the ``rte_eth_rx_descriptor_done()`` API function and its\n driver callback. It is replaced by the more complete function\n- ``rte_eth_rx_descriptor_status``.\n+ ``rte_eth_rx_descriptor_status()``.\n \n * ethdev: Removed deprecated ``shared`` attribute of the\n ``struct rte_flow_action_count``. Shared counters should be managed\n@@ -548,21 +555,21 @@ API Changes\n \n * ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data\n array is extended, data pointer field is explicitly added to union, the\n- action behavior is defined in more strict fashion and documentation updated.\n+ action behavior is defined in a more strict fashion and documentation updated.\n The immediate value behavior has been changed, the entire immediate field\n should be provided, and offset for immediate source bitfield is assigned\n- from destination one.\n+ from the destination one.\n \n * vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``,\n ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA\n driver interface are marked as internal.\n \n-* cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to\n- rte_cryptodev_is_valid_dev as it can be used by the application as\n- well as PMD to check whether the device is valid or not.\n+* cryptodev: The API ``rte_cryptodev_pmd_is_valid_dev()`` is modified to\n+ ``rte_cryptodev_is_valid_dev()`` as it can be used by the application as\n+ well as the PMD to check whether the device is valid or not.\n \n-* cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*\n- as it is for drivers only and should be private to DPDK, and not\n+* cryptodev: The ``rte_cryptodev_pmd.*`` files are renamed to ``cryptodev_pmd.*``\n+ since they are for drivers only and should be private to DPDK, and not\n installed for app use.\n \n * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was\n@@ -590,8 +597,8 @@ API Changes\n * ip_frag: All macros updated to have ``RTE_IP_FRAG_`` prefix.\n Obsolete macros are kept for compatibility.\n DPDK components updated to use new names.\n- Experimental function ``rte_frag_table_del_expired_entries`` was renamed\n- to ``rte_ip_frag_table_del_expired_entries``\n+ Experimental function ``rte_frag_table_del_expired_entries()`` was renamed\n+ to ``rte_ip_frag_table_del_expired_entries()``\n to comply with other public API naming convention.\n \n \n@@ -610,14 +617,14 @@ ABI Changes\n Also, make sure to start the actual text at the margin.\n =======================================================\n \n-* ethdev: All enums & macros updated to have ``RTE_ETH`` prefix and structures\n+* ethdev: All enums and macros updated to have ``RTE_ETH`` prefix and structures\n updated to have ``rte_eth`` prefix. DPDK components updated to use new names.\n \n-* ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.\n- Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer\n- to internal queue data as input parameter. While this change is transparent\n- to user, it still counts as an ABI change, as ``eth_rx_queue_count_t``\n- is used by public inline function ``rte_eth_rx_queue_count``.\n+* ethdev: The input parameters for ``eth_rx_queue_count_t`` were changed.\n+ Instead of a pointer to ``rte_eth_dev`` and queue index, it now accepts a pointer\n+ to internal queue data as an input parameter. While this change is transparent\n+ to the user, it still counts as an ABI change, as ``eth_rx_queue_count_t``\n+ is used by the public inline function ``rte_eth_rx_queue_count``.\n \n * ethdev: Made ``rte_eth_dev``, ``rte_eth_dev_data``, ``rte_eth_rxtx_callback``\n private data structures. ``rte_eth_devices[]`` can't be accessed directly\n@@ -663,7 +670,7 @@ ABI Changes\n \n * security: A new structure ``esn`` was added in structure\n ``rte_security_ipsec_xform`` to set an initial ESN value. This permits\n- application to start from an arbitrary ESN value for debug and SA lifetime\n+ applications to start from an arbitrary ESN value for debug and SA lifetime\n enforcement purposes.\n \n * security: A new structure ``udp`` was added in structure\n@@ -689,7 +696,7 @@ ABI Changes\n ``RTE_LIBRTE_IP_FRAG_MAX_FRAG`` from ``4`` to ``8``.\n This parameter controls maximum number of fragments per packet\n in IP reassembly table. Increasing this value from ``4`` to ``8``\n- will allow to cover common case with jumbo packet size of ``9KB``\n+ will allow covering the common case with jumbo packet size of ``9000B``\n and fragments with default frame size ``(1500B)``.\n \n \n", "prefixes": [ "v1" ] }