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