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