doc/guides/rel_notes/release_17_08.rst

   1 DPDK Release 17.08
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections 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:
  11    ``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       xdg-open build/doc/html/guides/rel_notes/release_17_08.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Added Generic Flow API support to enic.**
  45
  46   Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
  47   and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
  48   MARK, FLAG and VOID actions for ingress traffic.
  49
  50 * **Added support for Chelsio T6 family of adapters**
  51
  52   CXGBE PMD updated to run Chelsio T6 family of adapters.
  53
  54 * **Added latency and performance improvements for cxgbe**
  55
  56   TX and RX path reworked to improve performance.  Also reduced latency
  57   for slow traffic.
  58
  59 * **Updated bnxt PMD.**
  60
  61   Major enhancements include:
  62   * Support MTU modification.
  63   * Support LRO.
  64   * Support VLAN filter and strip functionality.
  65   * Other enhancements to add support for more dev_ops.
  66   * Add PMD specific APIs mainly to control VF from PF.
  67   * Update HWRM version to 1.7.7
  68
  69 * **Added support for Rx interrupts on mlx4 driver.**
  70
  71   Rx queues can be armed with an interrupt which will trigger on the
  72   next packet arrival.
  73
  74
  75 Resolved Issues
  76 ---------------
  77
  78 .. This section should contain bug fixes added to the relevant
  79    sections. Sample format:
  80
  81    * **code/section Fixed issue in the past tense with a full stop.**
  82
  83      Add a short 1-2 sentence description of the resolved issue in the past
  84      tense.
  85
  86      The title should contain the code/lib section like a commit message.
  87
  88      Add the entries in alphabetic order in the relevant sections below.
  89
  90    This section is a comment. do not overwrite or remove it.
  91    Also, make sure to start the actual text at the margin.
  92    =========================================================
  93
  94
  95 EAL
  96 ~~~
  97
  98
  99 Drivers
 100 ~~~~~~~
 101
 102
 103 Libraries
 104 ~~~~~~~~~
 105
 106
 107 Examples
 108 ~~~~~~~~
 109
 110
 111 Other
 112 ~~~~~
 113
 114
 115 Known Issues
 116 ------------
 117
 118 .. This section should contain new known issues in this release. Sample format:
 119
 120    * **Add title in present tense with full stop.**
 121
 122      Add a short 1-2 sentence description of the known issue in the present
 123      tense. Add information on any known workarounds.
 124
 125    This section is a comment. do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =========================================================
 128
 129
 130 API Changes
 131 -----------
 132
 133 .. This section should contain API changes. Sample format:
 134
 135    * Add a short 1-2 sentence description of the API change. Use fixed width
 136      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 137      tense.
 138
 139    This section is a comment. do not overwrite or remove it.
 140    Also, make sure to start the actual text at the margin.
 141    =========================================================
 142
 143
 144 ABI Changes
 145 -----------
 146
 147 .. This section should contain ABI changes. Sample format:
 148
 149    * Add a short 1-2 sentence description of the ABI change that was announced
 150      in the previous releases and made in this release. Use fixed width quotes
 151      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 152
 153    This section is a comment. do not overwrite or remove it.
 154    Also, make sure to start the actual text at the margin.
 155    =========================================================
 156
 157
 158
 159 Shared Library Versions
 160 -----------------------
 161
 162 .. Update any library version updated in this release and prepend with a ``+``
 163    sign, like this:
 164
 165      librte_acl.so.2
 166    + librte_cfgfile.so.2
 167      librte_cmdline.so.2
 168
 169    This section is a comment. do not overwrite or remove it.
 170    =========================================================
 171
 172
 173 The libraries prepended with a plus sign were incremented in this version.
 174
 175 .. code-block:: diff
 176
 177      librte_acl.so.2
 178      librte_bitratestats.so.1
 179      librte_cfgfile.so.2
 180      librte_cmdline.so.2
 181      librte_cryptodev.so.2
 182      librte_distributor.so.1
 183      librte_eal.so.4
 184      librte_ethdev.so.6
 185      librte_hash.so.2
 186      librte_ip_frag.so.1
 187      librte_jobstats.so.1
 188      librte_kni.so.2
 189      librte_kvargs.so.1
 190      librte_latencystats.so.1
 191      librte_lpm.so.2
 192      librte_mbuf.so.3
 193      librte_mempool.so.2
 194      librte_meter.so.1
 195      librte_metrics.so.1
 196      librte_net.so.1
 197      librte_pdump.so.1
 198      librte_pipeline.so.3
 199      librte_pmd_bond.so.1
 200      librte_pmd_ring.so.2
 201      librte_port.so.3
 202      librte_power.so.1
 203      librte_reorder.so.1
 204      librte_ring.so.1
 205      librte_sched.so.1
 206      librte_table.so.2
 207      librte_timer.so.1
 208      librte_vhost.so.3
 209
 210
 211 Tested Platforms
 212 ----------------
 213
 214 .. This section should contain a list of platforms that were tested with this
 215    release.
 216
 217    The format is:
 218
 219    * <vendor> platform with <vendor> <type of devices> combinations
 220
 221      * List of CPU
 222      * List of OS
 223      * List of devices
 224      * Other relevant details...
 225
 226    This section is a comment. do not overwrite or remove it.
 227    Also, make sure to start the actual text at the margin.
 228    =========================================================