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