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 support for generic flow API (rte_flow) on igb NIC.**
  45
  46   This API provides a generic means to configure hardware to match specific
  47   ingress or egress traffic, alter its behavior and query related counters
  48   according to any number of user-defined rules.
  49
  50   * Generic flow API support for Ethernet, IPv4, UDP, TCP and
  51     RAW pattern items with QUEUE actions. There are four
  52     type of filter support for this feature on igb.
  53
  54 * **Added Generic Flow API support to enic.**
  55
  56   Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
  57   and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
  58   MARK, FLAG and VOID actions for ingress traffic.
  59
  60 * **Added support for Chelsio T6 family of adapters**
  61
  62   CXGBE PMD updated to run Chelsio T6 family of adapters.
  63
  64 * **Added latency and performance improvements for cxgbe**
  65
  66   TX and RX path reworked to improve performance.  Also reduced latency
  67   for slow traffic.
  68
  69 * **Updated bnxt PMD.**
  70
  71   Major enhancements include:
  72   * Support MTU modification.
  73   * Support LRO.
  74   * Support VLAN filter and strip functionality.
  75   * Other enhancements to add support for more dev_ops.
  76   * Add PMD specific APIs mainly to control VF from PF.
  77   * Update HWRM version to 1.7.7
  78
  79 * **Added support for Rx interrupts on mlx4 driver.**
  80
  81   Rx queues can be armed with an interrupt which will trigger on the
  82   next packet arrival.
  83
  84 * **Updated szedata2 PMD.**
  85
  86   Added support for firmwares with multiple Ethernet ports per physical port.
  87
  88
  89 Resolved Issues
  90 ---------------
  91
  92 .. This section should contain bug fixes added to the relevant
  93    sections. Sample format:
  94
  95    * **code/section Fixed issue in the past tense with a full stop.**
  96
  97      Add a short 1-2 sentence description of the resolved issue in the past
  98      tense.
  99
 100      The title should contain the code/lib section like a commit message.
 101
 102      Add the entries in alphabetic order in the relevant sections below.
 103
 104    This section is a comment. do not overwrite or remove it.
 105    Also, make sure to start the actual text at the margin.
 106    =========================================================
 107
 108
 109 EAL
 110 ~~~
 111
 112
 113 Drivers
 114 ~~~~~~~
 115
 116
 117 Libraries
 118 ~~~~~~~~~
 119
 120
 121 Examples
 122 ~~~~~~~~
 123
 124
 125 Other
 126 ~~~~~
 127
 128
 129 Known Issues
 130 ------------
 131
 132 .. This section should contain new known issues in this release. Sample format:
 133
 134    * **Add title in present tense with full stop.**
 135
 136      Add a short 1-2 sentence description of the known issue in the present
 137      tense. Add information on any known workarounds.
 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 API Changes
 145 -----------
 146
 147 .. This section should contain API changes. Sample format:
 148
 149    * Add a short 1-2 sentence description of the API change. Use fixed width
 150      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 151      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 ABI Changes
 159 -----------
 160
 161 .. This section should contain ABI changes. Sample format:
 162
 163    * Add a short 1-2 sentence description of the ABI change that was announced
 164      in the previous releases and made in this release. Use fixed width quotes
 165      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 166
 167    This section is a comment. do not overwrite or remove it.
 168    Also, make sure to start the actual text at the margin.
 169    =========================================================
 170
 171
 172
 173 Shared Library Versions
 174 -----------------------
 175
 176 .. Update any library version updated in this release and prepend with a ``+``
 177    sign, like this:
 178
 179      librte_acl.so.2
 180    + librte_cfgfile.so.2
 181      librte_cmdline.so.2
 182
 183    This section is a comment. do not overwrite or remove it.
 184    =========================================================
 185
 186
 187 The libraries prepended with a plus sign were incremented in this version.
 188
 189 .. code-block:: diff
 190
 191      librte_acl.so.2
 192      librte_bitratestats.so.1
 193      librte_cfgfile.so.2
 194      librte_cmdline.so.2
 195      librte_cryptodev.so.2
 196      librte_distributor.so.1
 197      librte_eal.so.4
 198      librte_ethdev.so.6
 199      librte_hash.so.2
 200      librte_ip_frag.so.1
 201      librte_jobstats.so.1
 202      librte_kni.so.2
 203      librte_kvargs.so.1
 204      librte_latencystats.so.1
 205      librte_lpm.so.2
 206      librte_mbuf.so.3
 207      librte_mempool.so.2
 208      librte_meter.so.1
 209      librte_metrics.so.1
 210      librte_net.so.1
 211      librte_pdump.so.1
 212      librte_pipeline.so.3
 213      librte_pmd_bond.so.1
 214      librte_pmd_ring.so.2
 215      librte_port.so.3
 216      librte_power.so.1
 217      librte_reorder.so.1
 218      librte_ring.so.1
 219      librte_sched.so.1
 220      librte_table.so.2
 221      librte_timer.so.1
 222      librte_vhost.so.3
 223
 224
 225 Tested Platforms
 226 ----------------
 227
 228 .. This section should contain a list of platforms that were tested with this
 229    release.
 230
 231    The format is:
 232
 233    * <vendor> platform with <vendor> <type of devices> combinations
 234
 235      * List of CPU
 236      * List of OS
 237      * List of devices
 238      * Other relevant details...
 239
 240    This section is a comment. do not overwrite or remove it.
 241    Also, make sure to start the actual text at the margin.
 242    =========================================================