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