doc/guides/rel_notes/release_16_11.rst

   1 DPDK Release 16.11
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text below explains how to update the release notes.
   7
   8    Use proper spelling, capitalization and punctuation in all sections.
   9
  10    Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
  11
  12    Build the docs and view the output file to ensure the changes are correct::
  13
  14       make doc-guides-html
  15
  16       firefox build/doc/html/guides/rel_notes/release_16_11.html
  17
  18
  19 New Features
  20 ------------
  21
  22 .. This section should contain new features added in this release. Sample format:
  23
  24    * **Add a title in the past tense with a full stop.**
  25
  26      Add a short 1-2 sentence description in the past tense. The description
  27      should be enough to allow someone scanning the release notes to understand
  28      the new feature.
  29
  30      If the feature adds a lot of sub-features you can use a bullet list like this.
  31
  32      * Added feature foo to do something.
  33      * Enhanced feature bar to do something else.
  34
  35      Refer to the previous release notes for examples.
  36
  37      This section is a comment. Make sure to start the actual text at the margin.
  38
  39 * **Added vhost-user indirect descriptors support.**
  40
  41   If indirect descriptor feature is negotiated, each packet sent by the guest
  42   will take exactly one slot in the enqueue virtqueue. Without the feature, in
  43   current version, even 64 bytes packets take two slots with Virtio PMD on guest
  44   side.
  45
  46   The main impact is better performance for 0% packet loss use-cases, as it
  47   behaves as if the virtqueue size was enlarged, so more packets can be buffered
  48   in case of system perturbations. On the downside, small performance degradation
  49   is measured when running micro-benchmarks.
  50
  51 * **Added vhost PMD xstats.**
  52
  53   Added extended statistics to vhost PMD from per port perspective.
  54
  55 * **Added virtio NEON support for ARM.**
  56
  57 * **Updated the ixgbe base driver.**
  58
  59   Updated the ixgbe base driver, including the following changes:
  60
  61   * add X550em_a 10G PHY support
  62   * support flow control auto negotiation for X550em_a 1G PHY
  63   * add X550em_a FW ALEF support
  64   * increase mailbox version to ixgbe_mbox_api_13
  65   * add two MAC ops for Hyper-V support
  66
  67 * **Updated the QAT PMD.**
  68
  69   The QAT PMD was updated with following support:
  70
  71   * MD5_HMAC algorithm
  72   * SHA224-HMAC algorithm
  73   * SHA384-HMAC algorithm
  74   * KASUMI (F8 and F9) algorithm
  75   * NULL algorithm
  76
  77
  78 Resolved Issues
  79 ---------------
  80
  81 .. This section should contain bug fixes added to the relevant sections. Sample format:
  82
  83    * **code/section Fixed issue in the past tense with a full stop.**
  84
  85      Add a short 1-2 sentence description of the resolved issue in the past tense.
  86      The title should contain the code/lib section like a commit message.
  87      Add the entries in alphabetic order in the relevant sections below.
  88
  89    This section is a comment. Make sure to start the actual text at the margin.
  90
  91
  92 EAL
  93 ~~~
  94
  95
  96 Drivers
  97 ~~~~~~~
  98
  99
 100 Libraries
 101 ~~~~~~~~~
 102
 103
 104 Examples
 105 ~~~~~~~~
 106
 107
 108 Other
 109 ~~~~~
 110
 111
 112 Known Issues
 113 ------------
 114
 115 .. This section should contain new known issues in this release. Sample format:
 116
 117    * **Add title in present tense with full stop.**
 118
 119      Add a short 1-2 sentence description of the known issue in the present
 120      tense. Add information on any known workarounds.
 121
 122    This section is a comment. Make sure to start the actual text at the margin.
 123
 124
 125 API Changes
 126 -----------
 127
 128 .. This section should contain API changes. Sample format:
 129
 130    * Add a short 1-2 sentence description of the API change. Use fixed width
 131      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 132
 133    This section is a comment. Make sure to start the actual text at the margin.
 134
 135 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
 136   Examples: ``eth_pcap`` becomes ``net_pcap``
 137   and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
 138
 139 * The log history is removed.
 140
 141 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
 142   in 16.11 because it had some design issues which were not planned to be fixed.
 143
 144
 145 ABI Changes
 146 -----------
 147
 148 .. This section should contain ABI changes. Sample format:
 149
 150    * Add a short 1-2 sentence description of the ABI change that was announced in
 151      the previous releases and made in this release. Use fixed width quotes for
 152      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 153
 154    This section is a comment. Make sure to start the actual text at the margin.
 155
 156
 157
 158 Shared Library Versions
 159 -----------------------
 160
 161 .. Update any library version updated in this release and prepend with a ``+``
 162    sign, like this:
 163
 164      libethdev.so.4
 165      librte_acl.so.2
 166    + librte_cfgfile.so.2
 167      librte_cmdline.so.2
 168
 169
 170
 171 The libraries prepended with a plus sign were incremented in this version.
 172
 173 .. code-block:: diff
 174
 175      libethdev.so.4
 176      librte_acl.so.2
 177      librte_cfgfile.so.2
 178      librte_cmdline.so.2
 179      librte_cryptodev.so.1
 180      librte_distributor.so.1
 181    + librte_eal.so.3
 182      librte_hash.so.2
 183      librte_ip_frag.so.1
 184      librte_jobstats.so.1
 185      librte_kni.so.2
 186      librte_kvargs.so.1
 187      librte_lpm.so.2
 188      librte_mbuf.so.2
 189      librte_mempool.so.2
 190      librte_meter.so.1
 191      librte_pdump.so.1
 192      librte_pipeline.so.3
 193      librte_pmd_bond.so.1
 194      librte_pmd_ring.so.2
 195      librte_port.so.3
 196      librte_power.so.1
 197      librte_reorder.so.1
 198      librte_ring.so.1
 199      librte_sched.so.1
 200      librte_table.so.2
 201      librte_timer.so.1
 202      librte_vhost.so.3
 203
 204
 205 Tested Platforms
 206 ----------------
 207
 208 .. This section should contain a list of platforms that were tested with this release.
 209
 210    The format is:
 211
 212    #. Platform name.
 213
 214       * Platform details.
 215       * Platform details.
 216
 217    This section is a comment. Make sure to start the actual text at the margin.
 218
 219
 220 Tested NICs
 221 -----------
 222
 223 .. This section should contain a list of NICs that were tested with this release.
 224
 225    The format is:
 226
 227    #. NIC name.
 228
 229       * NIC details.
 230       * NIC details.
 231
 232    This section is a comment. Make sure to start the actual text at the margin.
 233
 234
 235 Tested OSes
 236 -----------
 237
 238 .. This section should contain a list of OSes that were tested with this release.
 239    The format is as follows, in alphabetical order:
 240
 241    * CentOS 7.0
 242    * Fedora 23
 243    * Fedora 24
 244    * FreeBSD 10.3
 245    * Red Hat Enterprise Linux 7.2
 246    * SUSE Enterprise Linux 12
 247    * Ubuntu 15.10
 248    * Ubuntu 16.04 LTS
 249    * Wind River Linux 8
 250
 251    This section is a comment. Make sure to start the actual text at the margin.