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