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