doc/guides/rel_notes/release_18_05.rst

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