doc/guides/rel_notes/release_19_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 19.11
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       make doc-guides-html
  21
  22       xdg-open build/doc/html/guides/rel_notes/release_19_11.html
  23
  24
  25 New Features
  26 ------------
  27
  28 .. This section should contain new features added in this release.
  29    Sample format:
  30
  31    * **Add a title in the past tense with a full stop.**
  32
  33      Add a short 1-2 sentence description in the past tense.
  34      The description should be enough to allow someone scanning
  35      the release notes to understand the new feature.
  36
  37      If the feature adds a lot of sub-features you can use a bullet list
  38      like this:
  39
  40      * Added feature foo to do something.
  41      * Enhanced feature bar to do something else.
  42
  43      Refer to the previous release notes for examples.
  44
  45      Suggested order in release notes items:
  46      * Core libs (EAL, mempool, ring, mbuf, buses)
  47      * Device abstraction libs and PMDs
  48        - ethdev (lib, PMDs)
  49        - cryptodev (lib, PMDs)
  50        - eventdev (lib, PMDs)
  51        - etc
  52      * Other libs
  53      * Apps, Examples, Tools (if significant)
  54
  55      This section is a comment. Do not overwrite or remove it.
  56      Also, make sure to start the actual text at the margin.
  57      =========================================================
  58
  59 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
  60
  61   Added stateful decompression support in the Intel QuickAssist Technology PMD.
  62   Please note that stateful compression is not supported.
  63
  64
  65 Removed Items
  66 -------------
  67
  68 .. This section should contain removed items in this release. Sample format:
  69
  70    * Add a short 1-2 sentence description of the removed item
  71      in the past tense.
  72
  73    This section is a comment. Do not overwrite or remove it.
  74    Also, make sure to start the actual text at the margin.
  75    =========================================================
  76
  77    * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
  78      “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
  79      hw-vlan-strip|hw-vlan-extend on|off”.
  80
  81      The testpmd commands set that can be used instead in order to enable or disable Rx
  82      offloading on all Rx queues of a port is:
  83      "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
  84      timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
  85
  86
  87 API Changes
  88 -----------
  89
  90 .. This section should contain API changes. Sample format:
  91
  92    * sample: Add a short 1-2 sentence description of the API change
  93      which was announced in the previous releases and made in this release.
  94      Start with a scope label like "ethdev:".
  95      Use fixed width quotes for ``function_names`` or ``struct_names``.
  96      Use the past tense.
  97
  98    This section is a comment. Do not overwrite or remove it.
  99    Also, make sure to start the actual text at the margin.
 100    =========================================================
 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.8
 150      librte_distributor.so.1
 151      librte_eal.so.11
 152      librte_efd.so.1
 153      librte_ethdev.so.12
 154      librte_eventdev.so.7
 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_ipsec.so.1
 161      librte_jobstats.so.1
 162      librte_kni.so.2
 163      librte_kvargs.so.1
 164      librte_latencystats.so.1
 165      librte_lpm.so.2
 166      librte_mbuf.so.5
 167      librte_member.so.1
 168      librte_mempool.so.5
 169      librte_meter.so.3
 170      librte_metrics.so.1
 171      librte_net.so.1
 172      librte_pci.so.1
 173      librte_pdump.so.3
 174      librte_pipeline.so.3
 175      librte_pmd_bnxt.so.2
 176      librte_pmd_bond.so.2
 177      librte_pmd_i40e.so.2
 178      librte_pmd_ixgbe.so.2
 179      librte_pmd_dpaa2_qdma.so.1
 180      librte_pmd_ring.so.2
 181      librte_pmd_softnic.so.1
 182      librte_pmd_vhost.so.2
 183      librte_port.so.3
 184      librte_power.so.1
 185      librte_rawdev.so.1
 186      librte_rcu.so.1
 187      librte_reorder.so.1
 188      librte_ring.so.2
 189      librte_sched.so.3
 190      librte_security.so.2
 191      librte_stack.so.1
 192      librte_table.so.3
 193      librte_timer.so.1
 194      librte_vhost.so.4
 195
 196
 197 Known Issues
 198 ------------
 199
 200 .. This section should contain new known issues in this release. Sample format:
 201
 202    * **Add title in present tense with full stop.**
 203
 204      Add a short 1-2 sentence description of the known issue
 205      in the present tense. Add information on any known workarounds.
 206
 207    This section is a comment. Do not overwrite or remove it.
 208    Also, make sure to start the actual text at the margin.
 209    =========================================================
 210
 211
 212 Tested Platforms
 213 ----------------
 214
 215 .. This section should contain a list of platforms that were tested
 216    with this release.
 217
 218    The format is:
 219
 220    * <vendor> platform with <vendor> <type of devices> combinations
 221
 222      * List of CPU
 223      * List of OS
 224      * List of devices
 225      * Other relevant details...
 226
 227    This section is a comment. Do not overwrite or remove it.
 228    Also, make sure to start the actual text at the margin.
 229    =========================================================
 230