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 * **Renamed avf to iavf.**
  75
  76   Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
  77   which includes the directory name, lib name, filenames, makefile, docs,
  78   macros, functions, structs and any other strings in the code.
  79
  80
  81 Removed Items
  82 -------------
  83
  84 .. This section should contain removed items in this release. Sample format:
  85
  86    * Add a short 1-2 sentence description of the removed item
  87      in the past tense.
  88
  89    This section is a comment. Do not overwrite or remove it.
  90    Also, make sure to start the actual text at the margin.
  91    =========================================================
  92
  93
  94 API Changes
  95 -----------
  96
  97 .. This section should contain API changes. Sample format:
  98
  99    * sample: Add a short 1-2 sentence description of the API change
 100      which was announced in the previous releases and made in this release.
 101      Start with a scope label like "ethdev:".
 102      Use fixed width quotes for ``function_names`` or ``struct_names``.
 103      Use the past tense.
 104
 105    This section is a comment. Do not overwrite or remove it.
 106    Also, make sure to start the actual text at the margin.
 107    =========================================================
 108
 109
 110 ABI Changes
 111 -----------
 112
 113 .. This section should contain ABI changes. Sample format:
 114
 115    * sample: Add a short 1-2 sentence description of the ABI change
 116      which was announced in the previous releases and made in this release.
 117      Start with a scope label like "ethdev:".
 118      Use fixed width quotes for ``function_names`` or ``struct_names``.
 119      Use the past tense.
 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 Shared Library Versions
 127 -----------------------
 128
 129 .. Update any library version updated in this release
 130    and prepend with a ``+`` sign, like this:
 131
 132      libfoo.so.1
 133    + libupdated.so.2
 134      libbar.so.1
 135
 136    This section is a comment. Do not overwrite or remove it.
 137    =========================================================
 138
 139 The libraries prepended with a plus sign were incremented in this version.
 140
 141 .. code-block:: diff
 142
 143      librte_acl.so.2
 144      librte_bbdev.so.1
 145      librte_bitratestats.so.2
 146      librte_bpf.so.1
 147      librte_bus_dpaa.so.2
 148      librte_bus_fslmc.so.2
 149      librte_bus_ifpga.so.2
 150      librte_bus_pci.so.2
 151      librte_bus_vdev.so.2
 152      librte_bus_vmbus.so.2
 153      librte_cfgfile.so.2
 154      librte_cmdline.so.2
 155      librte_compressdev.so.1
 156      librte_cryptodev.so.6
 157      librte_distributor.so.1
 158      librte_eal.so.9
 159      librte_efd.so.1
 160      librte_ethdev.so.11
 161      librte_eventdev.so.6
 162      librte_flow_classify.so.1
 163      librte_gro.so.1
 164      librte_gso.so.1
 165      librte_hash.so.2
 166      librte_ip_frag.so.1
 167      librte_jobstats.so.1
 168      librte_kni.so.2
 169      librte_kvargs.so.1
 170      librte_latencystats.so.1
 171      librte_lpm.so.2
 172      librte_mbuf.so.5
 173      librte_member.so.1
 174      librte_mempool.so.5
 175      librte_meter.so.2
 176      librte_metrics.so.1
 177      librte_net.so.1
 178      librte_pci.so.1
 179      librte_pdump.so.3
 180      librte_pipeline.so.3
 181      librte_pmd_bnxt.so.2
 182      librte_pmd_bond.so.2
 183      librte_pmd_i40e.so.2
 184      librte_pmd_ixgbe.so.2
 185      librte_pmd_dpaa2_qdma.so.1
 186      librte_pmd_ring.so.2
 187      librte_pmd_softnic.so.1
 188      librte_pmd_vhost.so.2
 189      librte_port.so.3
 190      librte_power.so.1
 191      librte_rawdev.so.1
 192      librte_reorder.so.1
 193      librte_ring.so.2
 194      librte_sched.so.2
 195      librte_security.so.2
 196      librte_table.so.3
 197      librte_timer.so.1
 198      librte_vhost.so.4
 199
 200
 201 Known Issues
 202 ------------
 203
 204 .. This section should contain new known issues in this release. Sample format:
 205
 206    * **Add title in present tense with full stop.**
 207
 208      Add a short 1-2 sentence description of the known issue
 209      in the present tense. Add information on any known workarounds.
 210
 211    This section is a comment. Do not overwrite or remove it.
 212    Also, make sure to start the actual text at the margin.
 213    =========================================================
 214
 215
 216 Tested Platforms
 217 ----------------
 218
 219 .. This section should contain a list of platforms that were tested
 220    with this release.
 221
 222    The format is:
 223
 224    * <vendor> platform with <vendor> <type of devices> combinations
 225
 226      * List of CPU
 227      * List of OS
 228      * List of devices
 229      * Other relevant details...
 230
 231    This section is a comment. Do not overwrite or remove it.
 232    Also, make sure to start the actual text at the margin.
 233    =========================================================