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