doc/guides/rel_notes/release_20_08.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.08
   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_08.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 * **Updated PCAP driver.**
  60
  61   Updated PCAP driver with new features and improvements, including:
  62
  63   * Support software Tx nanosecond timestamps precision.
  64
  65 * **Updated Mellanox mlx5 driver.**
  66
  67   Updated Mellanox mlx5 driver with new features and improvements, including:
  68
  69   * Added new PMD devarg ``reclaim_mem_mode``.
  70
  71
  72 Removed Items
  73 -------------
  74
  75 .. This section should contain removed items in this release. Sample format:
  76
  77    * Add a short 1-2 sentence description of the removed item
  78      in the past tense.
  79
  80    This section is a comment. Do not overwrite or remove it.
  81    Also, make sure to start the actual text at the margin.
  82    =========================================================
  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 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 101
 102
 103 ABI Changes
 104 -----------
 105
 106 .. This section should contain ABI changes. Sample format:
 107
 108    * sample: Add a short 1-2 sentence description of the ABI change
 109      which was announced in the previous releases and made in this release.
 110      Start with a scope label like "ethdev:".
 111      Use fixed width quotes for ``function_names`` or ``struct_names``.
 112      Use the past tense.
 113
 114    This section is a comment. Do not overwrite or remove it.
 115    Also, make sure to start the actual text at the margin.
 116    =========================================================
 117
 118 * No ABI change that would break compatibility with 19.11.
 119
 120
 121 Known Issues
 122 ------------
 123
 124 .. This section should contain new known issues in this release. Sample format:
 125
 126    * **Add title in present tense with full stop.**
 127
 128      Add a short 1-2 sentence description of the known issue
 129      in the present tense. Add information on any known workarounds.
 130
 131    This section is a comment. Do not overwrite or remove it.
 132    Also, make sure to start the actual text at the margin.
 133    =========================================================
 134
 135
 136 Tested Platforms
 137 ----------------
 138
 139 .. This section should contain a list of platforms that were tested
 140    with this release.
 141
 142    The format is:
 143
 144    * <vendor> platform with <vendor> <type of devices> combinations
 145
 146      * List of CPU
 147      * List of OS
 148      * List of devices
 149      * Other relevant details...
 150
 151    This section is a comment. Do not overwrite or remove it.
 152    Also, make sure to start the actual text at the margin.
 153    =========================================================