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 NXP crypto PMDs for PDCP support.**
  60
  61   PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
  62   Support is added for all sequence number sizes for control and user plane.
  63   Test application is updated for unit testing.
  64
  65 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
  66
  67   Added stateful decompression support in the Intel QuickAssist Technology PMD.
  68   Please note that stateful compression is not supported.
  69
  70
  71 Removed Items
  72 -------------
  73
  74 .. This section should contain removed items in this release. Sample format:
  75
  76    * Add a short 1-2 sentence description of the removed item
  77      in the past tense.
  78
  79    This section is a comment. Do not overwrite or remove it.
  80    Also, make sure to start the actual text at the margin.
  81    =========================================================
  82
  83    * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
  84      “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
  85      hw-vlan-strip|hw-vlan-extend on|off”.
  86
  87      The testpmd commands set that can be used instead in order to enable or disable Rx
  88      offloading on all Rx queues of a port is:
  89      "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
  90      timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
  91
  92
  93 API Changes
  94 -----------
  95
  96 .. This section should contain API changes. Sample format:
  97
  98    * sample: Add a short 1-2 sentence description of the API change
  99      which was announced in the previous releases and made in this release.
 100      Start with a scope label like "ethdev:".
 101      Use fixed width quotes for ``function_names`` or ``struct_names``.
 102      Use the past tense.
 103
 104    This section is a comment. Do not overwrite or remove it.
 105    Also, make sure to start the actual text at the margin.
 106    =========================================================
 107
 108
 109 ABI Changes
 110 -----------
 111
 112 .. This section should contain ABI changes. Sample format:
 113
 114    * sample: Add a short 1-2 sentence description of the ABI change
 115      which was announced in the previous releases and made in this release.
 116      Start with a scope label like "ethdev:".
 117      Use fixed width quotes for ``function_names`` or ``struct_names``.
 118      Use the past tense.
 119
 120    This section is a comment. Do not overwrite or remove it.
 121    Also, make sure to start the actual text at the margin.
 122    =========================================================
 123
 124
 125 Shared Library Versions
 126 -----------------------
 127
 128 .. Update any library version updated in this release
 129    and prepend with a ``+`` sign, like this:
 130
 131      libfoo.so.1
 132    + libupdated.so.2
 133      libbar.so.1
 134
 135    This section is a comment. Do not overwrite or remove it.
 136    =========================================================
 137
 138 The libraries prepended with a plus sign were incremented in this version.
 139
 140 .. code-block:: diff
 141
 142      librte_acl.so.2
 143      librte_bbdev.so.1
 144      librte_bitratestats.so.2
 145      librte_bpf.so.1
 146      librte_bus_dpaa.so.2
 147      librte_bus_fslmc.so.2
 148      librte_bus_ifpga.so.2
 149      librte_bus_pci.so.2
 150      librte_bus_vdev.so.2
 151      librte_bus_vmbus.so.2
 152      librte_cfgfile.so.2
 153      librte_cmdline.so.2
 154      librte_compressdev.so.1
 155      librte_cryptodev.so.8
 156      librte_distributor.so.1
 157      librte_eal.so.11
 158      librte_efd.so.1
 159      librte_ethdev.so.12
 160      librte_eventdev.so.7
 161      librte_flow_classify.so.1
 162      librte_gro.so.1
 163      librte_gso.so.1
 164      librte_hash.so.2
 165      librte_ip_frag.so.1
 166      librte_ipsec.so.1
 167      librte_jobstats.so.1
 168      librte_kni.so.2
 169      librte_kvargs.so.1
 170      librte_latencystats.so.1
 171      librte_lpm.so.2
 172      librte_mbuf.so.5
 173      librte_member.so.1
 174      librte_mempool.so.5
 175      librte_meter.so.3
 176      librte_metrics.so.1
 177      librte_net.so.1
 178      librte_pci.so.1
 179      librte_pdump.so.3
 180      librte_pipeline.so.3
 181      librte_pmd_bnxt.so.2
 182      librte_pmd_bond.so.2
 183      librte_pmd_i40e.so.2
 184      librte_pmd_ixgbe.so.2
 185      librte_pmd_dpaa2_qdma.so.1
 186      librte_pmd_ring.so.2
 187      librte_pmd_softnic.so.1
 188      librte_pmd_vhost.so.2
 189      librte_port.so.3
 190      librte_power.so.1
 191      librte_rawdev.so.1
 192      librte_rcu.so.1
 193      librte_reorder.so.1
 194      librte_ring.so.2
 195      librte_sched.so.3
 196      librte_security.so.2
 197      librte_stack.so.1
 198      librte_table.so.3
 199      librte_timer.so.1
 200      librte_vhost.so.4
 201
 202
 203 Known Issues
 204 ------------
 205
 206 .. This section should contain new known issues in this release. Sample format:
 207
 208    * **Add title in present tense with full stop.**
 209
 210      Add a short 1-2 sentence description of the known issue
 211      in the present tense. Add information on any known workarounds.
 212
 213    This section is a comment. Do not overwrite or remove it.
 214    Also, make sure to start the actual text at the margin.
 215    =========================================================
 216
 217
 218 Tested Platforms
 219 ----------------
 220
 221 .. This section should contain a list of platforms that were tested
 222    with this release.
 223
 224    The format is:
 225
 226    * <vendor> platform with <vendor> <type of devices> combinations
 227
 228      * List of CPU
 229      * List of OS
 230      * List of devices
 231      * Other relevant details...
 232
 233    This section is a comment. Do not overwrite or remove it.
 234    Also, make sure to start the actual text at the margin.
 235    =========================================================
 236