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