doc/guides/rel_notes/release_22_03.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 22.03
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       ninja -C build doc
  21       xdg-open build/doc/guides/html/rel_notes/release_22_03.html
  22
  23
  24 New Features
  25 ------------
  26
  27 .. This section should contain new features added in this release.
  28    Sample format:
  29
  30    * **Add a title in the past tense with a full stop.**
  31
  32      Add a short 1-2 sentence description in the past tense.
  33      The description should be enough to allow someone scanning
  34      the release notes to understand the new feature.
  35
  36      If the feature adds a lot of sub-features you can use a bullet list
  37      like this:
  38
  39      * Added feature foo to do something.
  40      * Enhanced feature bar to do something else.
  41
  42      Refer to the previous release notes for examples.
  43
  44      Suggested order in release notes items:
  45      * Core libs (EAL, mempool, ring, mbuf, buses)
  46      * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
  47        - ethdev (lib, PMDs)
  48        - cryptodev (lib, PMDs)
  49        - eventdev (lib, PMDs)
  50        - etc
  51      * Other libs
  52      * Apps, Examples, Tools (if significant)
  53
  54      This section is a comment. Do not overwrite or remove it.
  55      Also, make sure to start the actual text at the margin.
  56      =======================================================
  57
  58 * **Updated Marvell cnxk crypto PMD.**
  59
  60   * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
  61   * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
  62   * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
  63   * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
  64
  65 * **Added an API to retrieve event port id of ethdev Rx adapter.**
  66
  67   The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
  68
  69
  70 Removed Items
  71 -------------
  72
  73 .. This section should contain removed items in this release. Sample format:
  74
  75    * Add a short 1-2 sentence description of the removed item
  76      in the past tense.
  77
  78    This section is a comment. Do not overwrite or remove it.
  79    Also, make sure to start the actual text at the margin.
  80    =======================================================
  81
  82 * **Removed experimental performance thread example application.**
  83
  84
  85 API Changes
  86 -----------
  87
  88 .. This section should contain API changes. Sample format:
  89
  90    * sample: Add a short 1-2 sentence description of the API change
  91      which was announced in the previous releases and made in this release.
  92      Start with a scope label like "ethdev:".
  93      Use fixed width quotes for ``function_names`` or ``struct_names``.
  94      Use the past tense.
  95
  96    This section is a comment. Do not overwrite or remove it.
  97    Also, make sure to start the actual text at the margin.
  98    =======================================================
  99
 100
 101 ABI Changes
 102 -----------
 103
 104 .. This section should contain ABI changes. Sample format:
 105
 106    * sample: Add a short 1-2 sentence description of the ABI change
 107      which was announced in the previous releases and made in this release.
 108      Start with a scope label like "ethdev:".
 109      Use fixed width quotes for ``function_names`` or ``struct_names``.
 110      Use the past tense.
 111
 112    This section is a comment. Do not overwrite or remove it.
 113    Also, make sure to start the actual text at the margin.
 114    =======================================================
 115
 116 * No ABI change that would break compatibility with 21.11.
 117
 118
 119 Known Issues
 120 ------------
 121
 122 .. This section should contain new known issues in this release. Sample format:
 123
 124    * **Add title in present tense with full stop.**
 125
 126      Add a short 1-2 sentence description of the known issue
 127      in the present tense. Add information on any known workarounds.
 128
 129    This section is a comment. Do not overwrite or remove it.
 130    Also, make sure to start the actual text at the margin.
 131    =======================================================
 132
 133
 134 Tested Platforms
 135 ----------------
 136
 137 .. This section should contain a list of platforms that were tested
 138    with this release.
 139
 140    The format is:
 141
 142    * <vendor> platform with <vendor> <type of devices> combinations
 143
 144      * List of CPU
 145      * List of OS
 146      * List of devices
 147      * Other relevant details...
 148
 149    This section is a comment. Do not overwrite or remove it.
 150    Also, make sure to start the actual text at the margin.
 151    =======================================================