doc/guides/rel_notes/release_16_04.rst

   1 DPDK Release 16.04
   2 ==================
   3
   4
   5 **Read this first**
   6
   7 The text below explains how to update the release notes.
   8
   9 Use proper spelling, capitalization and punctuation in all sections.
  10
  11 Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
  12
  13 Build the docs and view the output file to ensure the changes are correct::
  14
  15    make doc-guides-html
  16
  17    firefox build/doc/html/guides/rel_notes/release_16_04.html
  18
  19
  20 New Features
  21 ------------
  22
  23 This section should contain new features added in this release. Sample format:
  24
  25 * **Add a title in the past tense with a full stop.**
  26
  27   Add a short 1-2 sentence description in the past tense. The description
  28   should be enough to allow someone scanning the release notes to understand
  29   the new feature.
  30
  31   If the feature adds a lot of sub-features you can use a bullet list like this.
  32
  33   * Added feature foo to do something.
  34   * Enhanced feature bar to do something else.
  35
  36   Refer to the previous release notes for examples.
  37
  38 * **Enabled bulk allocation of mbufs.**
  39
  40   A new function ``rte_pktmbuf_alloc_bulk()`` has been added to allow the user
  41   to allocate a bulk of mbufs.
  42
  43 * **Virtio 1.0.**
  44
  45   Enabled virtio 1.0 support for virtio pmd driver.
  46
  47 * **Supported virtio offload in vhost-user.**
  48
  49   Add the offload and negotiation of checksum and TSO between vhost-user and
  50   vanilla Linux virtio guest.
  51
  52 * **Added vhost-user live migration support.**
  53
  54
  55 Resolved Issues
  56 ---------------
  57
  58 This section should contain bug fixes added to the relevant sections. Sample format:
  59
  60 * **code/section Fixed issue in the past tense with a full stop.**
  61
  62   Add a short 1-2 sentence description of the resolved issue in the past tense.
  63   The title should contain the code/lib section like a commit message.
  64   Add the entries in alphabetic order in the relevant sections below.
  65
  66 * **examples/vhost: Fixed frequent mbuf allocation failure.**
  67
  68   vhost-switch often fails to allocate mbuf when dequeue from vring because it
  69   wrongly calculates the number of mbufs needed.
  70
  71
  72 EAL
  73 ~~~
  74
  75
  76 Drivers
  77 ~~~~~~~
  78
  79 * **aesni_mb: Fixed wrong return value when creating a device.**
  80
  81   cryptodev_aesni_mb_init() was returning the device id of the device created,
  82   instead of 0 (when success), that rte_eal_vdev_init() expects.
  83   This made impossible the creation of more than one aesni_mb device
  84   from command line.
  85
  86
  87 Libraries
  88 ~~~~~~~~~
  89
  90 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
  91
  92   Fix crc32c hash functions to return a valid crc32c value for data lengths
  93   not multiple of 4 bytes.
  94
  95
  96 Examples
  97 ~~~~~~~~
  98
  99
 100 Other
 101 ~~~~~
 102
 103
 104 Known Issues
 105 ------------
 106
 107 This section should contain new known issues in this release. Sample format:
 108
 109 * **Add title in present tense with full stop.**
 110
 111   Add a short 1-2 sentence description of the known issue in the present
 112   tense. Add information on any known workarounds.
 113
 114
 115 API Changes
 116 -----------
 117
 118 This section should contain API changes. Sample format:
 119
 120 * Add a short 1-2 sentence description of the API change. Use fixed width
 121   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 122
 123
 124 ABI Changes
 125 -----------
 126
 127 * Add a short 1-2 sentence description of the ABI change that was announced in
 128   the previous releases and made in this release. Use fixed width quotes for
 129   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 130
 131
 132 Shared Library Versions
 133 -----------------------
 134
 135 Update any library version updated in this release and prepend with a ``+`` sign.
 136
 137 The libraries prepended with a plus sign were incremented in this version.
 138
 139 .. code-block:: diff
 140
 141      libethdev.so.2
 142      librte_acl.so.2
 143      librte_cfgfile.so.2
 144      librte_cmdline.so.1
 145      librte_distributor.so.1
 146      librte_eal.so.2
 147      librte_hash.so.2
 148      librte_ip_frag.so.1
 149      librte_ivshmem.so.1
 150      librte_jobstats.so.1
 151      librte_kni.so.2
 152      librte_kvargs.so.1
 153      librte_lpm.so.2
 154      librte_mbuf.so.2
 155      librte_mempool.so.1
 156      librte_meter.so.1
 157      librte_pipeline.so.2
 158      librte_pmd_bond.so.1
 159      librte_pmd_ring.so.2
 160      librte_port.so.2
 161      librte_power.so.1
 162      librte_reorder.so.1
 163      librte_ring.so.1
 164      librte_sched.so.1
 165      librte_table.so.2
 166      librte_timer.so.1
 167      librte_vhost.so.2