doc/guides/rel_notes/release_19_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 19.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
  22       xdg-open build/doc/html/guides/rel_notes/release_19_11.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
 105 Shared Library Versions
 106 -----------------------
 107
 108 .. Update any library version updated in this release
 109    and prepend with a ``+`` sign, like this:
 110
 111      libfoo.so.1
 112    + libupdated.so.2
 113      libbar.so.1
 114
 115    This section is a comment. Do not overwrite or remove it.
 116    =========================================================
 117
 118 The libraries prepended with a plus sign were incremented in this version.
 119
 120 .. code-block:: diff
 121
 122      librte_acl.so.2
 123      librte_bbdev.so.1
 124      librte_bitratestats.so.2
 125      librte_bpf.so.1
 126      librte_bus_dpaa.so.2
 127      librte_bus_fslmc.so.2
 128      librte_bus_ifpga.so.2
 129      librte_bus_pci.so.2
 130      librte_bus_vdev.so.2
 131      librte_bus_vmbus.so.2
 132      librte_cfgfile.so.2
 133      librte_cmdline.so.2
 134      librte_compressdev.so.1
 135      librte_cryptodev.so.8
 136      librte_distributor.so.1
 137      librte_eal.so.11
 138      librte_efd.so.1
 139      librte_ethdev.so.12
 140      librte_eventdev.so.7
 141      librte_flow_classify.so.1
 142      librte_gro.so.1
 143      librte_gso.so.1
 144      librte_hash.so.2
 145      librte_ip_frag.so.1
 146      librte_ipsec.so.1
 147      librte_jobstats.so.1
 148      librte_kni.so.2
 149      librte_kvargs.so.1
 150      librte_latencystats.so.1
 151      librte_lpm.so.2
 152      librte_mbuf.so.5
 153      librte_member.so.1
 154      librte_mempool.so.5
 155      librte_meter.so.3
 156      librte_metrics.so.1
 157      librte_net.so.1
 158      librte_pci.so.1
 159      librte_pdump.so.3
 160      librte_pipeline.so.3
 161      librte_pmd_bnxt.so.2
 162      librte_pmd_bond.so.2
 163      librte_pmd_i40e.so.2
 164      librte_pmd_ixgbe.so.2
 165      librte_pmd_dpaa2_qdma.so.1
 166      librte_pmd_ring.so.2
 167      librte_pmd_softnic.so.1
 168      librte_pmd_vhost.so.2
 169      librte_port.so.3
 170      librte_power.so.1
 171      librte_rawdev.so.1
 172      librte_rcu.so.1
 173      librte_reorder.so.1
 174      librte_ring.so.2
 175      librte_sched.so.3
 176      librte_security.so.2
 177      librte_stack.so.1
 178      librte_table.so.3
 179      librte_timer.so.1
 180      librte_vhost.so.4
 181
 182
 183 Known Issues
 184 ------------
 185
 186 .. This section should contain new known issues in this release. Sample format:
 187
 188    * **Add title in present tense with full stop.**
 189
 190      Add a short 1-2 sentence description of the known issue
 191      in the present tense. Add information on any known workarounds.
 192
 193    This section is a comment. Do not overwrite or remove it.
 194    Also, make sure to start the actual text at the margin.
 195    =========================================================
 196
 197
 198 Tested Platforms
 199 ----------------
 200
 201 .. This section should contain a list of platforms that were tested
 202    with this release.
 203
 204    The format is:
 205
 206    * <vendor> platform with <vendor> <type of devices> combinations
 207
 208      * List of CPU
 209      * List of OS
 210      * List of devices
 211      * Other relevant details...
 212
 213    This section is a comment. Do not overwrite or remove it.
 214    Also, make sure to start the actual text at the margin.
 215    =========================================================
 216