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