doc/guides/rel_notes/release_20_02.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.02
   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       make doc-guides-html
  21
  22       xdg-open build/doc/html/guides/rel_notes/release_20_02.html
  23
  24
  25 New Features
  26 ------------
  27
  28 .. This section should contain new features added in this release.
  29    Sample format:
  30
  31    * **Add a title in the past tense with a full stop.**
  32
  33      Add a short 1-2 sentence description in the past tense.
  34      The description should be enough to allow someone scanning
  35      the release notes to understand the new feature.
  36
  37      If the feature adds a lot of sub-features you can use a bullet list
  38      like this:
  39
  40      * Added feature foo to do something.
  41      * Enhanced feature bar to do something else.
  42
  43      Refer to the previous release notes for examples.
  44
  45      Suggested order in release notes items:
  46      * Core libs (EAL, mempool, ring, mbuf, buses)
  47      * Device abstraction libs and PMDs
  48        - ethdev (lib, PMDs)
  49        - cryptodev (lib, PMDs)
  50        - eventdev (lib, PMDs)
  51        - etc
  52      * Other libs
  53      * Apps, Examples, Tools (if significant)
  54
  55      This section is a comment. Do not overwrite or remove it.
  56      Also, make sure to start the actual text at the margin.
  57      =========================================================
  58
  59 * **Added Wait Until Equal API.**
  60
  61   A new API has been added to wait for a memory location to be updated with a
  62   16-bit, 32-bit, 64-bit value.
  63
  64 * **Added algorithms to cryptodev API.**
  65
  66   * Chacha20-Poly1305 AEAD algorithm can now be supported in cryptodev.
  67   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
  68     asymmetric crypto library specifications.
  69   * ECPM (Elliptic Curve Point Multiplication) is added to
  70     asymmetric crypto library specifications.
  71
  72
  73 Removed Items
  74 -------------
  75
  76 .. This section should contain removed items in this release. Sample format:
  77
  78    * Add a short 1-2 sentence description of the removed item
  79      in the past tense.
  80
  81    This section is a comment. Do not overwrite or remove it.
  82    Also, make sure to start the actual text at the margin.
  83    =========================================================
  84
  85
  86 API Changes
  87 -----------
  88
  89 .. This section should contain API changes. Sample format:
  90
  91    * sample: Add a short 1-2 sentence description of the API change
  92      which was announced in the previous releases and made in this release.
  93      Start with a scope label like "ethdev:".
  94      Use fixed width quotes for ``function_names`` or ``struct_names``.
  95      Use the past tense.
  96
  97    This section is a comment. Do not overwrite or remove it.
  98    Also, make sure to start the actual text at the margin.
  99    =========================================================
 100
 101
 102 ABI Changes
 103 -----------
 104
 105 .. This section should contain ABI changes. Sample format:
 106
 107    * sample: Add a short 1-2 sentence description of the ABI change
 108      which was announced in the previous releases and made in this release.
 109      Start with a scope label like "ethdev:".
 110      Use fixed width quotes for ``function_names`` or ``struct_names``.
 111      Use the past tense.
 112
 113    This section is a comment. Do not overwrite or remove it.
 114    Also, make sure to start the actual text at the margin.
 115    =========================================================
 116
 117 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 118
 119
 120 Known Issues
 121 ------------
 122
 123 .. This section should contain new known issues in this release. Sample format:
 124
 125    * **Add title in present tense with full stop.**
 126
 127      Add a short 1-2 sentence description of the known issue
 128      in the present tense. Add information on any known workarounds.
 129
 130    This section is a comment. Do not overwrite or remove it.
 131    Also, make sure to start the actual text at the margin.
 132    =========================================================
 133
 134
 135 Tested Platforms
 136 ----------------
 137
 138 .. This section should contain a list of platforms that were tested
 139    with this release.
 140
 141    The format is:
 142
 143    * <vendor> platform with <vendor> <type of devices> combinations
 144
 145      * List of CPU
 146      * List of OS
 147      * List of devices
 148      * Other relevant details...
 149
 150    This section is a comment. Do not overwrite or remove it.
 151    Also, make sure to start the actual text at the margin.
 152    =========================================================