doc/guides/rel_notes/release_21_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.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_21_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 (ordered alphabetically by vendor name)
  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 * **Enabled new devargs parser.**
  59
  60   * Enabled devargs syntax
  61     ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
  62   * Added bus-level parsing of the devargs syntax.
  63   * Kept compatibility with the legacy syntax as parsing fallback.
  64
  65
  66 Removed Items
  67 -------------
  68
  69 .. This section should contain removed items in this release. Sample format:
  70
  71    * Add a short 1-2 sentence description of the removed item
  72      in the past tense.
  73
  74    This section is a comment. Do not overwrite or remove it.
  75    Also, make sure to start the actual text at the margin.
  76    =======================================================
  77
  78
  79 API Changes
  80 -----------
  81
  82 .. This section should contain API changes. Sample format:
  83
  84    * sample: Add a short 1-2 sentence description of the API change
  85      which was announced in the previous releases and made in this release.
  86      Start with a scope label like "ethdev:".
  87      Use fixed width quotes for ``function_names`` or ``struct_names``.
  88      Use the past tense.
  89
  90    This section is a comment. Do not overwrite or remove it.
  91    Also, make sure to start the actual text at the margin.
  92    =======================================================
  93
  94
  95 ABI Changes
  96 -----------
  97
  98 .. This section should contain ABI changes. Sample format:
  99
 100    * sample: Add a short 1-2 sentence description of the ABI change
 101      which was announced in the previous releases and made in this release.
 102      Start with a scope label like "ethdev:".
 103      Use fixed width quotes for ``function_names`` or ``struct_names``.
 104      Use the past tense.
 105
 106    This section is a comment. Do not overwrite or remove it.
 107    Also, make sure to start the actual text at the margin.
 108    =======================================================
 109
 110
 111 Known Issues
 112 ------------
 113
 114 .. This section should contain new known issues in this release. Sample format:
 115
 116    * **Add title in present tense with full stop.**
 117
 118      Add a short 1-2 sentence description of the known issue
 119      in the present tense. Add information on any known workarounds.
 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
 126 Tested Platforms
 127 ----------------
 128
 129 .. This section should contain a list of platforms that were tested
 130    with this release.
 131
 132    The format is:
 133
 134    * <vendor> platform with <vendor> <type of devices> combinations
 135
 136      * List of CPU
 137      * List of OS
 138      * List of devices
 139      * Other relevant details...
 140
 141    This section is a comment. Do not overwrite or remove it.
 142    Also, make sure to start the actual text at the margin.
 143    =======================================================