doc/guides/rel_notes/release_19_02.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 DPDK Release 19.02
   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_02.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 the enic driver.**
  58
  59   * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  60   * Added the handler to get firmware version string.
  61   * Added support for multicast filtering.
  62
  63 * **Added a compression performance test tool.**
  64
  65   Added a new performance test tool to test the compressdev PMD. The tool tests
  66   compression ratio and compression throughput.
  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 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
  98   ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
  99   since 18.05 and are removed in this release.
 100
 101
 102 ABI Changes
 103 -----------
 104
 105 .. This section should contain ABI changes. Sample format:
 106
 107    * sample: Add a short 1-2 sentence description of the ABI change
 108      which was announced in the previous releases and made in this release.
 109      Start with a scope label like "ethdev:".
 110      Use fixed width quotes for ``function_names`` or ``struct_names``.
 111      Use the past tense.
 112
 113    This section is a comment. Do not overwrite or remove it.
 114    Also, make sure to start the actual text at the margin.
 115    =========================================================
 116
 117
 118 Shared Library Versions
 119 -----------------------
 120
 121 .. Update any library version updated in this release
 122    and prepend with a ``+`` sign, like this:
 123
 124      libfoo.so.1
 125    + libupdated.so.2
 126      libbar.so.1
 127
 128    This section is a comment. Do not overwrite or remove it.
 129    =========================================================
 130
 131 The libraries prepended with a plus sign were incremented in this version.
 132
 133 .. code-block:: diff
 134
 135      librte_acl.so.2
 136      librte_bbdev.so.1
 137      librte_bitratestats.so.2
 138      librte_bpf.so.1
 139      librte_bus_dpaa.so.2
 140      librte_bus_fslmc.so.2
 141      librte_bus_ifpga.so.2
 142      librte_bus_pci.so.2
 143      librte_bus_vdev.so.2
 144      librte_bus_vmbus.so.2
 145      librte_cfgfile.so.2
 146      librte_cmdline.so.2
 147      librte_compressdev.so.1
 148      librte_cryptodev.so.5
 149      librte_distributor.so.1
 150      librte_eal.so.9
 151      librte_efd.so.1
 152      librte_ethdev.so.11
 153      librte_eventdev.so.6
 154      librte_flow_classify.so.1
 155      librte_gro.so.1
 156      librte_gso.so.1
 157      librte_hash.so.2
 158      librte_ip_frag.so.1
 159      librte_jobstats.so.1
 160      librte_kni.so.2
 161      librte_kvargs.so.1
 162      librte_latencystats.so.1
 163      librte_lpm.so.2
 164      librte_mbuf.so.4
 165      librte_member.so.1
 166      librte_mempool.so.5
 167      librte_meter.so.2
 168      librte_metrics.so.1
 169      librte_net.so.1
 170      librte_pci.so.1
 171    + librte_pdump.so.3
 172      librte_pipeline.so.3
 173      librte_pmd_bnxt.so.2
 174      librte_pmd_bond.so.2
 175      librte_pmd_i40e.so.2
 176      librte_pmd_ixgbe.so.2
 177      librte_pmd_dpaa2_qdma.so.1
 178      librte_pmd_ring.so.2
 179      librte_pmd_softnic.so.1
 180      librte_pmd_vhost.so.2
 181      librte_port.so.3
 182      librte_power.so.1
 183      librte_rawdev.so.1
 184      librte_reorder.so.1
 185      librte_ring.so.2
 186      librte_sched.so.1
 187      librte_security.so.1
 188      librte_table.so.3
 189      librte_timer.so.1
 190      librte_vhost.so.4
 191
 192
 193 Known Issues
 194 ------------
 195
 196 .. This section should contain new known issues in this release. Sample format:
 197
 198    * **Add title in present tense with full stop.**
 199
 200      Add a short 1-2 sentence description of the known issue
 201      in the present tense. Add information on any known workarounds.
 202
 203    This section is a comment. Do not overwrite or remove it.
 204    Also, make sure to start the actual text at the margin.
 205    =========================================================
 206
 207
 208 Tested Platforms
 209 ----------------
 210
 211 .. This section should contain a list of platforms that were tested
 212    with this release.
 213
 214    The format is:
 215
 216    * <vendor> platform with <vendor> <type of devices> combinations
 217
 218      * List of CPU
 219      * List of OS
 220      * List of devices
 221      * Other relevant details...
 222
 223    This section is a comment. Do not overwrite or remove it.
 224    Also, make sure to start the actual text at the margin.
 225    =========================================================