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
  70
  71 Removed Items
  72 -------------
  73
  74 .. This section should contain removed items in this release. Sample format:
  75
  76    * Add a short 1-2 sentence description of the removed item
  77      in the past tense.
  78
  79    This section is a comment. Do not overwrite or remove it.
  80    Also, make sure to start the actual text at the margin.
  81    =========================================================
  82
  83
  84 API Changes
  85 -----------
  86
  87 .. This section should contain API changes. Sample format:
  88
  89    * sample: Add a short 1-2 sentence description of the API change
  90      which was announced in the previous releases and made in this release.
  91      Start with a scope label like "ethdev:".
  92      Use fixed width quotes for ``function_names`` or ``struct_names``.
  93      Use the past tense.
  94
  95    This section is a comment. Do not overwrite or remove it.
  96    Also, make sure to start the actual text at the margin.
  97    =========================================================
  98
  99
 100 ABI Changes
 101 -----------
 102
 103 .. This section should contain ABI changes. Sample format:
 104
 105    * sample: Add a short 1-2 sentence description of the ABI change
 106      which was announced in the previous releases and made in this release.
 107      Start with a scope label like "ethdev:".
 108      Use fixed width quotes for ``function_names`` or ``struct_names``.
 109      Use the past tense.
 110
 111    This section is a comment. Do not overwrite or remove it.
 112    Also, make sure to start the actual text at the margin.
 113    =========================================================
 114
 115 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 116
 117
 118 Known Issues
 119 ------------
 120
 121 .. This section should contain new known issues in this release. Sample format:
 122
 123    * **Add title in present tense with full stop.**
 124
 125      Add a short 1-2 sentence description of the known issue
 126      in the present tense. Add information on any known workarounds.
 127
 128    This section is a comment. Do not overwrite or remove it.
 129    Also, make sure to start the actual text at the margin.
 130    =========================================================
 131
 132
 133 Tested Platforms
 134 ----------------
 135
 136 .. This section should contain a list of platforms that were tested
 137    with this release.
 138
 139    The format is:
 140
 141    * <vendor> platform with <vendor> <type of devices> combinations
 142
 143      * List of CPU
 144      * List of OS
 145      * List of devices
 146      * Other relevant details...
 147
 148    This section is a comment. Do not overwrite or remove it.
 149    Also, make sure to start the actual text at the margin.
 150    =========================================================