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