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