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