doc/guides/rel_notes/release_20_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.11
   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       xdg-open build/doc/html/guides/rel_notes/release_20_11.html
  22
  23
  24 New Features
  25 ------------
  26
  27 .. This section should contain new features added in this release.
  28    Sample format:
  29
  30    * **Add a title in the past tense with a full stop.**
  31
  32      Add a short 1-2 sentence description in the past tense.
  33      The description should be enough to allow someone scanning
  34      the release notes to understand the new feature.
  35
  36      If the feature adds a lot of sub-features you can use a bullet list
  37      like this:
  38
  39      * Added feature foo to do something.
  40      * Enhanced feature bar to do something else.
  41
  42      Refer to the previous release notes for examples.
  43
  44      Suggested order in release notes items:
  45      * Core libs (EAL, mempool, ring, mbuf, buses)
  46      * Device abstraction libs and PMDs
  47        - ethdev (lib, PMDs)
  48        - cryptodev (lib, PMDs)
  49        - eventdev (lib, PMDs)
  50        - etc
  51      * Other libs
  52      * Apps, Examples, Tools (if significant)
  53
  54      This section is a comment. Do not overwrite or remove it.
  55      Also, make sure to start the actual text at the margin.
  56      =======================================================
  57
  58
  59 Removed Items
  60 -------------
  61
  62 .. This section should contain removed items in this release. Sample format:
  63
  64    * Add a short 1-2 sentence description of the removed item
  65      in the past tense.
  66
  67    This section is a comment. Do not overwrite or remove it.
  68    Also, make sure to start the actual text at the margin.
  69    =======================================================
  70
  71
  72 API Changes
  73 -----------
  74
  75 .. This section should contain API changes. Sample format:
  76
  77    * sample: Add a short 1-2 sentence description of the API change
  78      which was announced in the previous releases and made in this release.
  79      Start with a scope label like "ethdev:".
  80      Use fixed width quotes for ``function_names`` or ``struct_names``.
  81      Use the past tense.
  82
  83    This section is a comment. Do not overwrite or remove it.
  84    Also, make sure to start the actual text at the margin.
  85    =======================================================
  86
  87 * eal: The ``rte_logs`` struct and global symbol was made private
  88   and is no longer part of the API.
  89
  90 * mbuf: Removed the unioned field ``refcnt_atomic`` from
  91   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
  92   The field ``refcnt`` is remaining from the old unions.
  93
  94 * rawdev: Added a structure size parameter to the functions
  95   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
  96   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
  97   allowing limited driver type-checking and ABI compatibility.
  98
  99 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 100   and the function ``rte_rawdev_queue_conf_get()``
 101   from ``void`` to ``int`` allowing the return of error codes from drivers.
 102
 103
 104 ABI Changes
 105 -----------
 106
 107 .. This section should contain ABI changes. Sample format:
 108
 109    * sample: Add a short 1-2 sentence description of the ABI change
 110      which was announced in the previous releases and made in this release.
 111      Start with a scope label like "ethdev:".
 112      Use fixed width quotes for ``function_names`` or ``struct_names``.
 113      Use the past tense.
 114
 115    This section is a comment. Do not overwrite or remove it.
 116    Also, make sure to start the actual text at the margin.
 117    =======================================================
 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    =======================================================