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 * **Added support for BPF_ABS/BPF_IND load instructions.**
  72
  73   Added support for two BPF non-generic instructions:
  74   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
  75   which are used to access packet data in a safe manner. Currently JIT support
  76   for these instructions is implemented for x86 only.
  77
  78
  79 Removed Items
  80 -------------
  81
  82 .. This section should contain removed items in this release. Sample format:
  83
  84    * Add a short 1-2 sentence description of the removed item
  85      in the past tense.
  86
  87    This section is a comment. Do not overwrite or remove it.
  88    Also, make sure to start the actual text at the margin.
  89    =========================================================
  90
  91
  92 API Changes
  93 -----------
  94
  95 .. This section should contain API changes. Sample format:
  96
  97    * sample: Add a short 1-2 sentence description of the API change
  98      which was announced in the previous releases and made in this release.
  99      Start with a scope label like "ethdev:".
 100      Use fixed width quotes for ``function_names`` or ``struct_names``.
 101      Use the past tense.
 102
 103    This section is a comment. Do not overwrite or remove it.
 104    Also, make sure to start the actual text at the margin.
 105    =========================================================
 106
 107 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 108
 109
 110 ABI Changes
 111 -----------
 112
 113 .. This section should contain ABI changes. Sample format:
 114
 115    * sample: Add a short 1-2 sentence description of the ABI change
 116      which was announced in the previous releases and made in this release.
 117      Start with a scope label like "ethdev:".
 118      Use fixed width quotes for ``function_names`` or ``struct_names``.
 119      Use the past tense.
 120
 121    This section is a comment. Do not overwrite or remove it.
 122    Also, make sure to start the actual text at the margin.
 123    =========================================================
 124
 125 * No ABI change that would break compatibility with 19.11.
 126
 127
 128 Known Issues
 129 ------------
 130
 131 .. This section should contain new known issues in this release. Sample format:
 132
 133    * **Add title in present tense with full stop.**
 134
 135      Add a short 1-2 sentence description of the known issue
 136      in the present tense. Add information on any known workarounds.
 137
 138    This section is a comment. Do not overwrite or remove it.
 139    Also, make sure to start the actual text at the margin.
 140    =========================================================
 141
 142
 143 Tested Platforms
 144 ----------------
 145
 146 .. This section should contain a list of platforms that were tested
 147    with this release.
 148
 149    The format is:
 150
 151    * <vendor> platform with <vendor> <type of devices> combinations
 152
 153      * List of CPU
 154      * List of OS
 155      * List of devices
 156      * Other relevant details...
 157
 158    This section is a comment. Do not overwrite or remove it.
 159    Also, make sure to start the actual text at the margin.
 160    =========================================================