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