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