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