X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Frelease_21_02.rst;h=9d5e17758f804bf539fab74bb292a73935f0e50e;hb=34fd4373ce76efd0236e59397c495762c2ec9e64;hp=743f1505efd0142517c5dd43fc42874afa15819e;hpb=b7ede165aed04e86345926849f9436676fad52bd;p=dpdk.git diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst index 743f1505ef..9d5e17758f 100644 --- a/doc/guides/rel_notes/release_21_02.rst +++ b/doc/guides/rel_notes/release_21_02.rst @@ -6,20 +6,6 @@ DPDK Release 21.02 ================== -.. **Read this first.** - - The text in the sections below explains how to update the release notes. - - Use proper spelling, capitalization and punctuation in all sections. - - Variable and config names should be quoted as fixed width text: - ``LIKE_THIS``. - - Build the docs and view the output file to ensure the changes are correct:: - - make doc-guides-html - xdg-open build/doc/html/guides/rel_notes/release_21_02.html - .. note:: A **dependency** has been added for building DPDK on Linux or FreeBSD: @@ -34,37 +20,6 @@ DPDK Release 21.02 New Features ------------ -.. This section should contain new features added in this release. - Sample format: - - * **Add a title in the past tense with a full stop.** - - Add a short 1-2 sentence description in the past tense. - The description should be enough to allow someone scanning - the release notes to understand the new feature. - - If the feature adds a lot of sub-features you can use a bullet list - like this: - - * Added feature foo to do something. - * Enhanced feature bar to do something else. - - Refer to the previous release notes for examples. - - Suggested order in release notes items: - * Core libs (EAL, mempool, ring, mbuf, buses) - * Device abstraction libs and PMDs - - ethdev (lib, PMDs) - - cryptodev (lib, PMDs) - - eventdev (lib, PMDs) - - etc - * Other libs - * Apps, Examples, Tools (if significant) - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - * **Added new ethdev API for PMD power management.** Added ``rte_eth_get_monitor_addr()``, to be used in conjunction with @@ -84,9 +39,9 @@ New Features Added support for matching and raw encap/decap of GENEVE TLV option. -* **Added support of modify field action in the flow API.** +* **Added support for Modify field action in the flow API.** - Added modify action support to perform various operations on + Added "modify" action support to rte_flow to perform various operations on any arbitrary header field (as well as mark, metadata or tag values): ``RTE_FLOW_ACTION_TYPE_MODIFY_FIELD``. Supported operations are: overwriting a field with the content from @@ -100,22 +55,22 @@ New Features * **Updated Cisco enic driver.** - * Added support for 64B completion queue entries + * Added support for 64B completion queue entries. * **Updated Hisilicon hns3 driver.** - * Added support for traffic management + * Added support for traffic management. * **Updated Intel i40e driver.** - * Added support on Windows. + * Added Intel i40e support on Windows. * **Updated Intel ice driver.** Updated the Intel ice driver with new features and improvements, including: * Added Double VLAN support for DCF switch QinQ filtering. - * Added support for UDP dynamic port assignment for eCPRI tunnel in DCF. + * Added support for UDP dynamic port assignment for eCPRI tunnels in DCF. * **Updated Intel iavf driver.** @@ -130,9 +85,9 @@ New Features * Introduced basic support on Windows. * Added GTP PDU session container matching and raw encap/decap. - * Added support for RSS action in the sample sub-actions list. + * Added support for a RSS action in the sample sub-actions list. * Added support for E-Switch mirroring and jump action in the same flow. - * Added support to handle modify action in correct order regarding the + * Added support to handle the modify action in correct order regarding the mirroring action on E-Switch. * Enlarged the number of flow priorities to 21844 (0 - 21843) for ingress or egress flow groups greater than 0 and for any transfer flow group. @@ -162,10 +117,10 @@ New Features * Added inner UDP/IPv4 support for VXLAN IPv4 GSO. -* **Added enqueue & dequeue callback APIs for cryptodev library.** +* **Added enqueue and dequeue callback APIs for cryptodev library.** - Cryptodev library is added with enqueue & dequeue callback APIs to - enable applications to add/remove user callbacks which gets called + The Cryptodev library has been enhanced with enqueue and dequeue callback APIs to + enable applications to add/remove user callbacks which get called for every enqueue/dequeue operation. * **Updated the OCTEON TX2 crypto PMD.** @@ -186,7 +141,7 @@ New Features * **Added python script to run crypto perf tests and graph the results.** - A new python script has been added to automate running crypto performance + A new Python script has been added to automate running crypto performance tests and output graphed results to PDF files. See the :doc:`../tools/cryptoperf` guide for more details. @@ -209,15 +164,6 @@ New Features Removed Items ------------- -.. This section should contain removed items in this release. Sample format: - - * Add a short 1-2 sentence description of the removed item - in the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - * The internal header files ``rte_ethdev_driver.h``, ``rte_ethdev_vdev.h`` and ``rte_ethdev_pci.h`` are no longer installed as part of the DPDK ``ninja install`` action and are renamed to ``ethdev_driver.h``, @@ -243,18 +189,6 @@ Removed Items API Changes ----------- -.. This section should contain API changes. Sample format: - - * sample: Add a short 1-2 sentence description of the API change - which was announced in the previous releases and made in this release. - Start with a scope label like "ethdev:". - Use fixed width quotes for ``function_names`` or ``struct_names``. - Use the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - * config: Removed the old macros, included in ``rte_config.h``, to indicate which DPDK libraries and drivers are built. The new macros are generated by meson in a standardized format: @@ -269,18 +203,6 @@ API Changes ABI Changes ----------- -.. This section should contain ABI changes. Sample format: - - * sample: Add a short 1-2 sentence description of the ABI change - which was announced in the previous releases and made in this release. - Start with a scope label like "ethdev:". - Use fixed width quotes for ``function_names`` or ``struct_names``. - Use the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - * No ABI change that would break compatibility with 20.11. * The experimental function ``rte_telemetry_init`` has been removed from the @@ -289,40 +211,9 @@ ABI Changes application need use it. -Known Issues ------------- - -.. This section should contain new known issues in this release. Sample format: - - * **Add title in present tense with full stop.** - - Add a short 1-2 sentence description of the known issue - in the present tense. Add information on any known workarounds. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - - Tested Platforms ---------------- -.. This section should contain a list of platforms that were tested - with this release. - - The format is: - - * platform with combinations - - * List of CPU - * List of OS - * List of devices - * Other relevant details... - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= - * Intel\ |reg| platforms with Intel\ |reg| NICs combinations * CPU