doc/guides/rel_notes/release_16_07.rst

   1 DPDK Release 16.07
   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_07.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 * **Removed mempool cache if not needed.**
  38
  39   The size of the mempool structure is reduced if the per-lcore cache is disabled.
  40
  41
  42 Resolved Issues
  43 ---------------
  44
  45 .. This section should contain bug fixes added to the relevant sections. Sample format:
  46
  47    * **code/section Fixed issue in the past tense with a full stop.**
  48
  49      Add a short 1-2 sentence description of the resolved issue in the past tense.
  50      The title should contain the code/lib section like a commit message.
  51      Add the entries in alphabetic order in the relevant sections below.
  52
  53
  54 EAL
  55 ~~~
  56
  57
  58 Drivers
  59 ~~~~~~~
  60
  61 * **i40e: Fixed vlan stripping from inner header.**
  62
  63   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
  64   tags of the inner header will be stripped without putting vlan
  65   info to descriptor.
  66   Now this issue is fixed by disabling vlan stripping from inner header.
  67
  68
  69 Libraries
  70 ~~~~~~~~~
  71
  72
  73 Examples
  74 ~~~~~~~~
  75
  76
  77 Other
  78 ~~~~~
  79
  80
  81 Known Issues
  82 ------------
  83
  84 .. This section should contain new known issues in this release. Sample format:
  85
  86    * **Add title in present tense with full stop.**
  87
  88      Add a short 1-2 sentence description of the known issue in the present
  89      tense. Add information on any known workarounds.
  90
  91
  92 API Changes
  93 -----------
  94
  95 .. This section should contain API changes. Sample format:
  96
  97    * Add a short 1-2 sentence description of the API change. Use fixed width
  98      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  99
 100 * The following counters are removed from ``rte_eth_stats`` structure:
 101   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
 102   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
 103
 104
 105 ABI Changes
 106 -----------
 107
 108 .. * Add a short 1-2 sentence description of the ABI change that was announced in
 109      the previous releases and made in this release. Use fixed width quotes for
 110      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 111
 112 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
 113   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
 114
 115
 116 Shared Library Versions
 117 -----------------------
 118
 119 .. Update any library version updated in this release and prepend with a ``+`` sign.
 120
 121 The libraries prepended with a plus sign were incremented in this version.
 122
 123 .. code-block:: diff
 124
 125    + libethdev.so.4
 126      librte_acl.so.2
 127      librte_cfgfile.so.2
 128      librte_cmdline.so.2
 129      librte_distributor.so.1
 130      librte_eal.so.2
 131      librte_hash.so.2
 132      librte_ip_frag.so.1
 133      librte_ivshmem.so.1
 134      librte_jobstats.so.1
 135      librte_kni.so.2
 136      librte_kvargs.so.1
 137      librte_lpm.so.2
 138      librte_mbuf.so.2
 139    + librte_mempool.so.2
 140      librte_meter.so.1
 141      librte_pipeline.so.3
 142      librte_pmd_bond.so.1
 143      librte_pmd_ring.so.2
 144    + librte_port.so.3
 145      librte_power.so.1
 146      librte_reorder.so.1
 147      librte_ring.so.1
 148      librte_sched.so.1
 149      librte_table.so.2
 150      librte_timer.so.1
 151      librte_vhost.so.2
 152
 153
 154 Tested Platforms
 155 ----------------
 156
 157 .. This section should contain a list of platforms that were tested with this
 158    release.
 159
 160    The format is:
 161
 162    #. Platform name.
 163
 164       - Platform details.
 165       - Platform details.
 166
 167
 168 Tested NICs
 169 -----------
 170
 171 .. This section should contain a list of NICs that were tested with this release.
 172
 173    The format is:
 174
 175    #. NIC name.
 176
 177       - NIC details.
 178       - NIC details.