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 * meter: updated to accommodate configuration profiles.
  76
  77   The meter API is changed to support meter configuration profiles. The
  78   configuration profile represents the set of configuration parameters
  79   for a given meter object, such as the rates and sizes for the token
  80   buckets. These configuration parameters were previously the part of meter
  81   object internal data strcuture. The separation of the configuration
  82   parameters from meter object data structure results in reducing its
  83   memory footprint which helps in better cache utilization when large number
  84   of meter objects are used.
  85
  86
  87 ABI Changes
  88 -----------
  89
  90 .. This section should contain ABI changes. Sample format:
  91
  92    * Add a short 1-2 sentence description of the ABI change that was announced
  93      in the previous releases and made in this release. Use fixed width quotes
  94      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  95
  96    This section is a comment. Do not overwrite or remove it.
  97    Also, make sure to start the actual text at the margin.
  98    =========================================================
  99
 100
 101 Removed Items
 102 -------------
 103
 104 .. This section should contain removed items in this release. Sample format:
 105
 106    * Add a short 1-2 sentence description of the removed item in the past
 107      tense.
 108
 109    This section is a comment. Do not overwrite or remove it.
 110    Also, make sure to start the actual text at the margin.
 111    =========================================================
 112
 113
 114 Known Issues
 115 ------------
 116
 117 .. This section should contain new known issues in this release. Sample format:
 118
 119    * **Add title in present tense with full stop.**
 120
 121      Add a short 1-2 sentence description of the known issue in the present
 122      tense. Add information on any known workarounds.
 123
 124    This section is a comment. Do not overwrite or remove it.
 125    Also, make sure to start the actual text at the margin.
 126    =========================================================
 127
 128
 129 Shared Library Versions
 130 -----------------------
 131
 132 .. Update any library version updated in this release and prepend with a ``+``
 133    sign, like this:
 134
 135      librte_acl.so.2
 136    + librte_cfgfile.so.2
 137      librte_cmdline.so.2
 138
 139    This section is a comment. Do not overwrite or remove it.
 140    =========================================================
 141
 142
 143 The libraries prepended with a plus sign were incremented in this version.
 144
 145 .. code-block:: diff
 146
 147      librte_acl.so.2
 148      librte_bbdev.so.1
 149      librte_bitratestats.so.2
 150      librte_bus_dpaa.so.1
 151      librte_bus_fslmc.so.1
 152      librte_bus_pci.so.1
 153      librte_bus_vdev.so.1
 154      librte_cfgfile.so.2
 155      librte_cmdline.so.2
 156    + librte_common_octeontx.so.1
 157      librte_cryptodev.so.4
 158      librte_distributor.so.1
 159    + librte_eal.so.7
 160    + librte_ethdev.so.9
 161      librte_eventdev.so.3
 162      librte_flow_classify.so.1
 163      librte_gro.so.1
 164      librte_gso.so.1
 165      librte_hash.so.2
 166      librte_ip_frag.so.1
 167      librte_jobstats.so.1
 168      librte_kni.so.2
 169      librte_kvargs.so.1
 170      librte_latencystats.so.1
 171      librte_lpm.so.2
 172      librte_mbuf.so.3
 173      librte_mempool.so.3
 174    + librte_meter.so.2
 175      librte_metrics.so.1
 176      librte_net.so.1
 177      librte_pci.so.1
 178      librte_pdump.so.2
 179      librte_pipeline.so.3
 180      librte_pmd_bnxt.so.2
 181      librte_pmd_bond.so.2
 182      librte_pmd_i40e.so.2
 183      librte_pmd_ixgbe.so.2
 184      librte_pmd_ring.so.2
 185      librte_pmd_softnic.so.1
 186      librte_pmd_vhost.so.2
 187      librte_port.so.3
 188      librte_power.so.1
 189      librte_rawdev.so.1
 190      librte_reorder.so.1
 191      librte_ring.so.1
 192      librte_sched.so.1
 193      librte_security.so.1
 194      librte_table.so.3
 195      librte_timer.so.1
 196      librte_vhost.so.3
 197
 198
 199 Tested Platforms
 200 ----------------
 201
 202 .. This section should contain a list of platforms that were tested with this
 203    release.
 204
 205    The format is:
 206
 207    * <vendor> platform with <vendor> <type of devices> combinations
 208
 209      * List of CPU
 210      * List of OS
 211      * List of devices
 212      * Other relevant details...
 213
 214    This section is a comment. Do not overwrite or remove it.
 215    Also, make sure to start the actual text at the margin.
 216    =========================================================