doc/guides/rel_notes/release_22_07.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2022 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 22.07
   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_07.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 * **Added vhost API to get the number of in-flight packets.**
  59
  60   Added an API which can get the number of in-flight packets in
  61   vhost async data path without using lock.
  62
  63 * **Updated Intel iavf driver.**
  64
  65   * Added Tx QoS queue rate limitation support.
  66   * Added quanta size configuration support.
  67   * Added ``DEV_RX_OFFLOAD_TIMESTAMP`` support.
  68
  69 * **Updated Mellanox mlx5 driver.**
  70
  71   * Added support for promiscuous mode on Windows.
  72   * Added support for MTU on Windows.
  73
  74 * **Updated Marvell cnxk crypto driver.**
  75
  76   * Added AH mode support in lookaside protocol (IPsec) for CN9K & CN10K.
  77   * Added AES-GMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
  78
  79
  80 Removed Items
  81 -------------
  82
  83 .. This section should contain removed items in this release. Sample format:
  84
  85    * Add a short 1-2 sentence description of the removed item
  86      in the past tense.
  87
  88    This section is a comment. Do not overwrite or remove it.
  89    Also, make sure to start the actual text at the margin.
  90    =======================================================
  91
  92
  93 API Changes
  94 -----------
  95
  96 .. This section should contain API changes. Sample format:
  97
  98    * sample: Add a short 1-2 sentence description of the API change
  99      which was announced in the previous releases and made in this release.
 100      Start with a scope label like "ethdev:".
 101      Use fixed width quotes for ``function_names`` or ``struct_names``.
 102      Use the past tense.
 103
 104    This section is a comment. Do not overwrite or remove it.
 105    Also, make sure to start the actual text at the margin.
 106    =======================================================
 107
 108
 109 ABI Changes
 110 -----------
 111
 112 .. This section should contain ABI changes. Sample format:
 113
 114    * sample: Add a short 1-2 sentence description of the ABI change
 115      which was announced in the previous releases and made in this release.
 116      Start with a scope label like "ethdev:".
 117      Use fixed width quotes for ``function_names`` or ``struct_names``.
 118      Use the past tense.
 119
 120    This section is a comment. Do not overwrite or remove it.
 121    Also, make sure to start the actual text at the margin.
 122    =======================================================
 123
 124 * No ABI change that would break compatibility with 21.11.
 125
 126
 127 Known Issues
 128 ------------
 129
 130 .. This section should contain new known issues in this release. Sample format:
 131
 132    * **Add title in present tense with full stop.**
 133
 134      Add a short 1-2 sentence description of the known issue
 135      in the present tense. Add information on any known workarounds.
 136
 137    This section is a comment. Do not overwrite or remove it.
 138    Also, make sure to start the actual text at the margin.
 139    =======================================================
 140
 141
 142 Tested Platforms
 143 ----------------
 144
 145 .. This section should contain a list of platforms that were tested
 146    with this release.
 147
 148    The format is:
 149
 150    * <vendor> platform with <vendor> <type of devices> combinations
 151
 152      * List of CPU
 153      * List of OS
 154      * List of devices
 155      * Other relevant details...
 156
 157    This section is a comment. Do not overwrite or remove it.
 158    Also, make sure to start the actual text at the margin.
 159    =======================================================