doc/guides/rel_notes/release_18_02.rst

   1 DPDK Release 18.02
   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_18_02.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 * **Add MAC loopback support for i40e.**
  45
  46   Add MAC loopback support for i40e in order to support test task asked by
  47   users. According to the device configuration, it will setup TX->RX loopback
  48   link or not.
  49
  50 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
  51
  52   Added support for NVGRE, VXLAN and GENEVE tunnels.
  53
  54   * Added support for UDP tunnel ports configuration.
  55   * Added tunneled packets classification.
  56   * Added inner checksum offload.
  57
  58 * **Added the igb ethernet driver to support RSS with flow API.**
  59
  60   Rte_flow actually defined to include RSS, but till now, RSS is out of
  61   rte_flow. This patch is to support igb NIC with existing RSS configuration
  62   using rte_flow API.
  63
  64
  65 API Changes
  66 -----------
  67
  68 .. This section should contain API changes. Sample format:
  69
  70    * Add a short 1-2 sentence description of the API change. Use fixed width
  71      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
  72      tense.
  73
  74    This section is a comment. do not overwrite or remove it.
  75    Also, make sure to start the actual text at the margin.
  76    =========================================================
  77
  78
  79 ABI Changes
  80 -----------
  81
  82 .. This section should contain ABI changes. Sample format:
  83
  84    * Add a short 1-2 sentence description of the ABI change that was announced
  85      in the previous releases and made in this release. Use fixed width quotes
  86      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  87
  88    This section is a comment. do not overwrite or remove it.
  89    Also, make sure to start the actual text at the margin.
  90    =========================================================
  91
  92
  93 Removed Items
  94 -------------
  95
  96 .. This section should contain removed items in this release. Sample format:
  97
  98    * Add a short 1-2 sentence description of the removed item in the past
  99      tense.
 100
 101    This section is a comment. do not overwrite or remove it.
 102    Also, make sure to start the actual text at the margin.
 103    =========================================================
 104
 105
 106 Known Issues
 107 ------------
 108
 109 .. This section should contain new known issues in this release. Sample format:
 110
 111    * **Add title in present tense with full stop.**
 112
 113      Add a short 1-2 sentence description of the known issue in the present
 114      tense. Add information on any known workarounds.
 115
 116    This section is a comment. do not overwrite or remove it.
 117    Also, make sure to start the actual text at the margin.
 118    =========================================================
 119
 120
 121 Shared Library Versions
 122 -----------------------
 123
 124 .. Update any library version updated in this release and prepend with a ``+``
 125    sign, like this:
 126
 127      librte_acl.so.2
 128    + librte_cfgfile.so.2
 129      librte_cmdline.so.2
 130
 131    This section is a comment. do not overwrite or remove it.
 132    =========================================================
 133
 134
 135 The libraries prepended with a plus sign were incremented in this version.
 136
 137 .. code-block:: diff
 138
 139      librte_acl.so.2
 140      librte_bitratestats.so.2
 141      librte_bus_dpaa.so.1
 142      librte_bus_fslmc.so.1
 143      librte_bus_pci.so.1
 144      librte_bus_vdev.so.1
 145      librte_cfgfile.so.2
 146      librte_cmdline.so.2
 147      librte_cryptodev.so.4
 148      librte_distributor.so.1
 149      librte_eal.so.6
 150      librte_ethdev.so.8
 151      librte_eventdev.so.3
 152      librte_flow_classify.so.1
 153      librte_gro.so.1
 154      librte_gso.so.1
 155      librte_hash.so.2
 156      librte_ip_frag.so.1
 157      librte_jobstats.so.1
 158      librte_kni.so.2
 159      librte_kvargs.so.1
 160      librte_latencystats.so.1
 161      librte_lpm.so.2
 162      librte_mbuf.so.3
 163      librte_mempool.so.3
 164      librte_meter.so.1
 165      librte_metrics.so.1
 166      librte_net.so.1
 167      librte_pci.so.1
 168      librte_pdump.so.2
 169      librte_pipeline.so.3
 170      librte_pmd_bnxt.so.2
 171      librte_pmd_bond.so.2
 172      librte_pmd_i40e.so.2
 173      librte_pmd_ixgbe.so.2
 174      librte_pmd_ring.so.2
 175      librte_pmd_softnic.so.1
 176      librte_pmd_vhost.so.2
 177      librte_port.so.3
 178      librte_power.so.1
 179      librte_reorder.so.1
 180      librte_ring.so.1
 181      librte_sched.so.1
 182      librte_security.so.1
 183      librte_table.so.3
 184      librte_timer.so.1
 185      librte_vhost.so.3
 186
 187
 188
 189 Tested Platforms
 190 ----------------
 191
 192 .. This section should contain a list of platforms that were tested with this
 193    release.
 194
 195    The format is:
 196
 197    * <vendor> platform with <vendor> <type of devices> combinations
 198
 199      * List of CPU
 200      * List of OS
 201      * List of devices
 202      * Other relevant details...
 203
 204    This section is a comment. do not overwrite or remove it.
 205    Also, make sure to start the actual text at the margin.
 206    =========================================================