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   * C62XX device
  77
  78
  79 Resolved Issues
  80 ---------------
  81
  82 .. This section should contain bug fixes added to the relevant sections. Sample format:
  83
  84    * **code/section Fixed issue in the past tense with a full stop.**
  85
  86      Add a short 1-2 sentence description of the resolved issue in the past tense.
  87      The title should contain the code/lib section like a commit message.
  88      Add the entries in alphabetic order in the relevant sections below.
  89
  90    This section is a comment. Make sure to start the actual text at the margin.
  91
  92
  93 EAL
  94 ~~~
  95
  96
  97 Drivers
  98 ~~~~~~~
  99
 100
 101 Libraries
 102 ~~~~~~~~~
 103
 104
 105 Examples
 106 ~~~~~~~~
 107
 108
 109 Other
 110 ~~~~~
 111
 112
 113 Known Issues
 114 ------------
 115
 116 .. This section should contain new known issues in this release. Sample format:
 117
 118    * **Add title in present tense with full stop.**
 119
 120      Add a short 1-2 sentence description of the known issue in the present
 121      tense. Add information on any known workarounds.
 122
 123    This section is a comment. Make sure to start the actual text at the margin.
 124
 125
 126 API Changes
 127 -----------
 128
 129 .. This section should contain API changes. Sample format:
 130
 131    * Add a short 1-2 sentence description of the API change. Use fixed width
 132      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 133
 134    This section is a comment. Make sure to start the actual text at the margin.
 135
 136 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
 137   Examples: ``eth_pcap`` becomes ``net_pcap``
 138   and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
 139
 140 * The log history is removed.
 141
 142 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
 143   in 16.11 because it had some design issues which were not planned to be fixed.
 144
 145
 146 ABI Changes
 147 -----------
 148
 149 .. This section should contain ABI changes. Sample format:
 150
 151    * Add a short 1-2 sentence description of the ABI change that was announced in
 152      the previous releases and made in this release. Use fixed width quotes for
 153      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 154
 155    This section is a comment. Make sure to start the actual text at the margin.
 156
 157
 158
 159 Shared Library Versions
 160 -----------------------
 161
 162 .. Update any library version updated in this release and prepend with a ``+``
 163    sign, like this:
 164
 165      libethdev.so.4
 166      librte_acl.so.2
 167    + librte_cfgfile.so.2
 168      librte_cmdline.so.2
 169
 170
 171
 172 The libraries prepended with a plus sign were incremented in this version.
 173
 174 .. code-block:: diff
 175
 176      libethdev.so.4
 177      librte_acl.so.2
 178      librte_cfgfile.so.2
 179      librte_cmdline.so.2
 180      librte_cryptodev.so.1
 181      librte_distributor.so.1
 182    + librte_eal.so.3
 183      librte_hash.so.2
 184      librte_ip_frag.so.1
 185      librte_jobstats.so.1
 186      librte_kni.so.2
 187      librte_kvargs.so.1
 188      librte_lpm.so.2
 189      librte_mbuf.so.2
 190      librte_mempool.so.2
 191      librte_meter.so.1
 192      librte_pdump.so.1
 193      librte_pipeline.so.3
 194      librte_pmd_bond.so.1
 195      librte_pmd_ring.so.2
 196      librte_port.so.3
 197      librte_power.so.1
 198      librte_reorder.so.1
 199      librte_ring.so.1
 200      librte_sched.so.1
 201      librte_table.so.2
 202      librte_timer.so.1
 203      librte_vhost.so.3
 204
 205
 206 Tested Platforms
 207 ----------------
 208
 209 .. This section should contain a list of platforms that were tested with this release.
 210
 211    The format is:
 212
 213    #. Platform name.
 214
 215       * Platform details.
 216       * Platform details.
 217
 218    This section is a comment. Make sure to start the actual text at the margin.
 219
 220
 221 Tested NICs
 222 -----------
 223
 224 .. This section should contain a list of NICs that were tested with this release.
 225
 226    The format is:
 227
 228    #. NIC name.
 229
 230       * NIC details.
 231       * NIC details.
 232
 233    This section is a comment. Make sure to start the actual text at the margin.
 234
 235
 236 Tested OSes
 237 -----------
 238
 239 .. This section should contain a list of OSes that were tested with this release.
 240    The format is as follows, in alphabetical order:
 241
 242    * CentOS 7.0
 243    * Fedora 23
 244    * Fedora 24
 245    * FreeBSD 10.3
 246    * Red Hat Enterprise Linux 7.2
 247    * SUSE Enterprise Linux 12
 248    * Ubuntu 15.10
 249    * Ubuntu 16.04 LTS
 250    * Wind River Linux 8
 251
 252    This section is a comment. Make sure to start the actual text at the margin.