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