doc/guides/rel_notes/release_19_05.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 DPDK Release 19.05
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_19_05.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significant)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57 * **Updated Solarflare network PMD.**
  58
  59   Updated the sfc_efx driver including the following changes:
  60
  61   * Added support for Rx descriptor status and related API in a secondary
  62     process.
  63   * Added support for Tx descriptor status API in a secondary process.
  64   * Added support for RSS RETA and hash configuration get API in a secondary
  65     process.
  66   * Added support for Rx packet types list in a secondary process.
  67
  68 * **Updated Mellanox drivers.**
  69
  70    New features and improvements were done in mlx4 and mlx5 PMDs:
  71
  72    * Added firmware version reading.
  73
  74
  75 Removed Items
  76 -------------
  77
  78 .. This section should contain removed items in this release. Sample format:
  79
  80    * Add a short 1-2 sentence description of the removed item
  81      in 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
  88 API Changes
  89 -----------
  90
  91 .. This section should contain API changes. Sample format:
  92
  93    * sample: Add a short 1-2 sentence description of the API change
  94      which was announced in the previous releases and made in this release.
  95      Start with a scope label like "ethdev:".
  96      Use fixed width quotes for ``function_names`` or ``struct_names``.
  97      Use the past tense.
  98
  99    This section is a comment. Do not overwrite or remove it.
 100    Also, make sure to start the actual text at the margin.
 101    =========================================================
 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 Shared Library Versions
 121 -----------------------
 122
 123 .. Update any library version updated in this release
 124    and prepend with a ``+`` sign, like this:
 125
 126      libfoo.so.1
 127    + libupdated.so.2
 128      libbar.so.1
 129
 130    This section is a comment. Do not overwrite or remove it.
 131    =========================================================
 132
 133 The libraries prepended with a plus sign were incremented in this version.
 134
 135 .. code-block:: diff
 136
 137      librte_acl.so.2
 138      librte_bbdev.so.1
 139      librte_bitratestats.so.2
 140      librte_bpf.so.1
 141      librte_bus_dpaa.so.2
 142      librte_bus_fslmc.so.2
 143      librte_bus_ifpga.so.2
 144      librte_bus_pci.so.2
 145      librte_bus_vdev.so.2
 146      librte_bus_vmbus.so.2
 147      librte_cfgfile.so.2
 148      librte_cmdline.so.2
 149      librte_compressdev.so.1
 150      librte_cryptodev.so.6
 151      librte_distributor.so.1
 152      librte_eal.so.9
 153      librte_efd.so.1
 154      librte_ethdev.so.11
 155      librte_eventdev.so.6
 156      librte_flow_classify.so.1
 157      librte_gro.so.1
 158      librte_gso.so.1
 159      librte_hash.so.2
 160      librte_ip_frag.so.1
 161      librte_jobstats.so.1
 162      librte_kni.so.2
 163      librte_kvargs.so.1
 164      librte_latencystats.so.1
 165      librte_lpm.so.2
 166      librte_mbuf.so.5
 167      librte_member.so.1
 168      librte_mempool.so.5
 169      librte_meter.so.2
 170      librte_metrics.so.1
 171      librte_net.so.1
 172      librte_pci.so.1
 173      librte_pdump.so.3
 174      librte_pipeline.so.3
 175      librte_pmd_bnxt.so.2
 176      librte_pmd_bond.so.2
 177      librte_pmd_i40e.so.2
 178      librte_pmd_ixgbe.so.2
 179      librte_pmd_dpaa2_qdma.so.1
 180      librte_pmd_ring.so.2
 181      librte_pmd_softnic.so.1
 182      librte_pmd_vhost.so.2
 183      librte_port.so.3
 184      librte_power.so.1
 185      librte_rawdev.so.1
 186      librte_reorder.so.1
 187      librte_ring.so.2
 188      librte_sched.so.2
 189      librte_security.so.2
 190      librte_table.so.3
 191      librte_timer.so.1
 192      librte_vhost.so.4
 193
 194
 195 Known Issues
 196 ------------
 197
 198 .. This section should contain new known issues in this release. Sample format:
 199
 200    * **Add title in present tense with full stop.**
 201
 202      Add a short 1-2 sentence description of the known issue
 203      in the present tense. Add information on any known workarounds.
 204
 205    This section is a comment. Do not overwrite or remove it.
 206    Also, make sure to start the actual text at the margin.
 207    =========================================================
 208
 209
 210 Tested Platforms
 211 ----------------
 212
 213 .. This section should contain a list of platforms that were tested
 214    with this release.
 215
 216    The format is:
 217
 218    * <vendor> platform with <vendor> <type of devices> combinations
 219
 220      * List of CPU
 221      * List of OS
 222      * List of devices
 223      * Other relevant details...
 224
 225    This section is a comment. Do not overwrite or remove it.
 226    Also, make sure to start the actual text at the margin.
 227    =========================================================