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 * **Virtio 1.0.**
  39
  40   Enabled virtio 1.0 support for virtio pmd driver.
  41
  42 * **Supported virtio offload in vhost-user.**
  43
  44   Add the offload and negotiation of checksum and TSO between vhost-user and
  45   vanilla Linux virtio guest.
  46
  47 * **Added vhost-user live migration support.**
  48
  49
  50 Resolved Issues
  51 ---------------
  52
  53 This section should contain bug fixes added to the relevant sections. Sample format:
  54
  55 * **code/section Fixed issue in the past tense with a full stop.**
  56
  57   Add a short 1-2 sentence description of the resolved issue in the past tense.
  58   The title should contain the code/lib section like a commit message.
  59   Add the entries in alphabetic order in the relevant sections below.
  60
  61
  62 EAL
  63 ~~~
  64
  65
  66 Drivers
  67 ~~~~~~~
  68
  69 * **aesni_mb: Fixed wrong return value when creating a device.**
  70
  71   cryptodev_aesni_mb_init() was returning the device id of the device created,
  72   instead of 0 (when success), that rte_eal_vdev_init() expects.
  73   This made impossible the creation of more than one aesni_mb device
  74   from command line.
  75
  76
  77 Libraries
  78 ~~~~~~~~~
  79
  80
  81 Examples
  82 ~~~~~~~~
  83
  84
  85 Other
  86 ~~~~~
  87
  88
  89 Known Issues
  90 ------------
  91
  92 This section should contain new known issues in this release. Sample format:
  93
  94 * **Add title in present tense with full stop.**
  95
  96   Add a short 1-2 sentence description of the known issue in the present
  97   tense. Add information on any known workarounds.
  98
  99
 100 API Changes
 101 -----------
 102
 103 This section should contain API changes. Sample format:
 104
 105 * Add a short 1-2 sentence description of the API change. Use fixed width
 106   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 107
 108
 109 ABI Changes
 110 -----------
 111
 112 * Add a short 1-2 sentence description of the ABI change that was announced in
 113   the previous releases and made in this release. Use fixed width quotes for
 114   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 115
 116
 117 Shared Library Versions
 118 -----------------------
 119
 120 Update any library version updated in this release and prepend with a ``+`` sign.
 121
 122 The libraries prepended with a plus sign were incremented in this version.
 123
 124 .. code-block:: diff
 125
 126      libethdev.so.2
 127      librte_acl.so.2
 128      librte_cfgfile.so.2
 129      librte_cmdline.so.1
 130      librte_distributor.so.1
 131      librte_eal.so.2
 132      librte_hash.so.2
 133      librte_ip_frag.so.1
 134      librte_ivshmem.so.1
 135      librte_jobstats.so.1
 136      librte_kni.so.2
 137      librte_kvargs.so.1
 138      librte_lpm.so.2
 139      librte_mbuf.so.2
 140      librte_mempool.so.1
 141      librte_meter.so.1
 142      librte_pipeline.so.2
 143      librte_pmd_bond.so.1
 144      librte_pmd_ring.so.2
 145      librte_port.so.2
 146      librte_power.so.1
 147      librte_reorder.so.1
 148      librte_ring.so.1
 149      librte_sched.so.1
 150      librte_table.so.2
 151      librte_timer.so.1
 152      librte_vhost.so.2