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