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