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