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