doc/guides/rel_notes/release_18_08.rst

   1 DPDK Release 18.08
   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_08.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release.
  24    Sample 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.
  29      The description should be enough to allow someone scanning
  30      the release notes to understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list
  33      like 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 Flow API support for CXGBE PMD.**
  45
  46   Flow API support has been added to CXGBE Poll Mode Driver to offload
  47   flows to Chelsio T5/T6 NICs.
  48
  49 * **Added ixgbe preferred Rx/Tx parameters.**
  50
  51   Rather than applications providing explicit Rx and Tx parameters such as
  52   queue and burst sizes, they can request that the EAL instead uses preferred
  53   values provided by the PMD, falling back to defaults within the EAL if the
  54   PMD does not provide any. The provision of such tuned values now includes
  55   the ixgbe PMD.
  56
  57 * **Added descriptor status check support for fm10k.**
  58
  59   ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status``
  60   are supported by fm10K.
  61
  62 * **Updated the enic driver.**
  63
  64   * Add support for mbuf fast free offload.
  65   * Add low cycle count Tx handler for no-offload Tx (except mbuf fast free).
  66   * Add low cycle count Rx handler for non-scattered Rx.
  67   * Minor performance improvements to scattered Rx handler.
  68   * Add handlers to add/delete VxLAN port number.
  69   * Add devarg to specify ingress VLAN rewrite mode.
  70
  71
  72 API Changes
  73 -----------
  74
  75 .. This section should contain API changes. Sample format:
  76
  77    * Add a short 1-2 sentence description of the API change.
  78      Use fixed width quotes for ``function_names`` or ``struct_names``.
  79      Use the past tense.
  80
  81    This section is a comment. Do not overwrite or remove it.
  82    Also, make sure to start the actual text at the margin.
  83    =========================================================
  84
  85 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
  86   replaced with the following more explicit flags:
  87   - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
  88   - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
  89   - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
  90
  91
  92 ABI Changes
  93 -----------
  94
  95 .. This section should contain ABI changes. Sample format:
  96
  97    * Add a short 1-2 sentence description of the ABI change
  98      that was announced in the previous releases and made in this release.
  99      Use fixed width quotes for ``function_names`` or ``struct_names``.
 100      Use the past tense.
 101
 102    This section is a comment. Do not overwrite or remove it.
 103    Also, make sure to start the actual text at the margin.
 104    =========================================================
 105
 106
 107 Removed Items
 108 -------------
 109
 110 .. This section should contain removed items in this release. Sample format:
 111
 112    * Add a short 1-2 sentence description of the removed item
 113      in the past tense.
 114
 115    This section is a comment. Do not overwrite or remove it.
 116    Also, make sure to start the actual text at the margin.
 117    =========================================================
 118
 119
 120 Shared Library Versions
 121 -----------------------
 122
 123 .. Update any library version updated in this release
 124    and prepend with a ``+`` sign, like this:
 125
 126      librte_acl.so.2
 127    + librte_cfgfile.so.2
 128      librte_cmdline.so.2
 129
 130    This section is a comment. Do not overwrite or remove it.
 131    =========================================================
 132
 133 The libraries prepended with a plus sign were incremented in this version.
 134
 135 .. code-block:: diff
 136
 137      librte_acl.so.2
 138      librte_bbdev.so.1
 139      librte_bitratestats.so.2
 140      librte_bpf.so.1
 141      librte_bus_dpaa.so.1
 142      librte_bus_fslmc.so.1
 143      librte_bus_pci.so.1
 144      librte_bus_vdev.so.1
 145      librte_cfgfile.so.2
 146      librte_cmdline.so.2
 147      librte_common_octeontx.so.1
 148      librte_compressdev.so.1
 149      librte_cryptodev.so.4
 150      librte_distributor.so.1
 151      librte_eal.so.7
 152      librte_ethdev.so.9
 153      librte_eventdev.so.4
 154      librte_flow_classify.so.1
 155      librte_gro.so.1
 156      librte_gso.so.1
 157      librte_hash.so.2
 158      librte_ip_frag.so.1
 159      librte_jobstats.so.1
 160      librte_kni.so.2
 161      librte_kvargs.so.1
 162      librte_latencystats.so.1
 163      librte_lpm.so.2
 164      librte_mbuf.so.4
 165      librte_mempool.so.4
 166      librte_meter.so.2
 167      librte_metrics.so.1
 168      librte_net.so.1
 169      librte_pci.so.1
 170      librte_pdump.so.2
 171      librte_pipeline.so.3
 172      librte_pmd_bnxt.so.2
 173      librte_pmd_bond.so.2
 174      librte_pmd_i40e.so.2
 175      librte_pmd_ixgbe.so.2
 176      librte_pmd_dpaa2_cmdif.so.1
 177      librte_pmd_dpaa2_qdma.so.1
 178      librte_pmd_ring.so.2
 179      librte_pmd_softnic.so.1
 180      librte_pmd_vhost.so.2
 181      librte_port.so.3
 182      librte_power.so.1
 183      librte_rawdev.so.1
 184      librte_reorder.so.1
 185      librte_ring.so.2
 186      librte_sched.so.1
 187      librte_security.so.1
 188      librte_table.so.3
 189      librte_timer.so.1
 190      librte_vhost.so.3
 191
 192
 193 Known Issues
 194 ------------
 195
 196 .. This section should contain new known issues in this release. Sample format:
 197
 198    * **Add title in present tense with full stop.**
 199
 200      Add a short 1-2 sentence description of the known issue
 201      in the present tense. Add information on any known workarounds.
 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    =========================================================
 206
 207
 208 Tested Platforms
 209 ----------------
 210
 211 .. This section should contain a list of platforms that were tested
 212    with this release.
 213
 214    The format is:
 215
 216    * <vendor> platform with <vendor> <type of devices> combinations
 217
 218      * List of CPU
 219      * List of OS
 220      * List of devices
 221      * Other relevant details...
 222
 223    This section is a comment. Do not overwrite or remove it.
 224    Also, make sure to start the actual text at the margin.
 225    =========================================================