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
  86 ABI Changes
  87 -----------
  88
  89 .. This section should contain ABI changes. Sample format:
  90
  91    * Add a short 1-2 sentence description of the ABI change
  92      that was announced in the previous releases and made in this release.
  93      Use fixed width quotes for ``function_names`` or ``struct_names``.
  94      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
 107      in 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 Shared Library Versions
 115 -----------------------
 116
 117 .. Update any library version updated in this release
 118    and prepend with a ``+`` sign, like this:
 119
 120      librte_acl.so.2
 121    + librte_cfgfile.so.2
 122      librte_cmdline.so.2
 123
 124    This section is a comment. Do not overwrite or remove it.
 125    =========================================================
 126
 127 The libraries prepended with a plus sign were incremented in this version.
 128
 129 .. code-block:: diff
 130
 131      librte_acl.so.2
 132      librte_bbdev.so.1
 133      librte_bitratestats.so.2
 134      librte_bpf.so.1
 135      librte_bus_dpaa.so.1
 136      librte_bus_fslmc.so.1
 137      librte_bus_pci.so.1
 138      librte_bus_vdev.so.1
 139      librte_cfgfile.so.2
 140      librte_cmdline.so.2
 141      librte_common_octeontx.so.1
 142      librte_compressdev.so.1
 143      librte_cryptodev.so.4
 144      librte_distributor.so.1
 145      librte_eal.so.7
 146      librte_ethdev.so.9
 147      librte_eventdev.so.4
 148      librte_flow_classify.so.1
 149      librte_gro.so.1
 150      librte_gso.so.1
 151      librte_hash.so.2
 152      librte_ip_frag.so.1
 153      librte_jobstats.so.1
 154      librte_kni.so.2
 155      librte_kvargs.so.1
 156      librte_latencystats.so.1
 157      librte_lpm.so.2
 158      librte_mbuf.so.4
 159      librte_mempool.so.4
 160      librte_meter.so.2
 161      librte_metrics.so.1
 162      librte_net.so.1
 163      librte_pci.so.1
 164      librte_pdump.so.2
 165      librte_pipeline.so.3
 166      librte_pmd_bnxt.so.2
 167      librte_pmd_bond.so.2
 168      librte_pmd_i40e.so.2
 169      librte_pmd_ixgbe.so.2
 170      librte_pmd_dpaa2_cmdif.so.1
 171      librte_pmd_dpaa2_qdma.so.1
 172      librte_pmd_ring.so.2
 173      librte_pmd_softnic.so.1
 174      librte_pmd_vhost.so.2
 175      librte_port.so.3
 176      librte_power.so.1
 177      librte_rawdev.so.1
 178      librte_reorder.so.1
 179      librte_ring.so.2
 180      librte_sched.so.1
 181      librte_security.so.1
 182      librte_table.so.3
 183      librte_timer.so.1
 184      librte_vhost.so.3
 185
 186
 187 Known Issues
 188 ------------
 189
 190 .. This section should contain new known issues in this release. Sample format:
 191
 192    * **Add title in present tense with full stop.**
 193
 194      Add a short 1-2 sentence description of the known issue
 195      in the present tense. Add information on any known workarounds.
 196
 197    This section is a comment. Do not overwrite or remove it.
 198    Also, make sure to start the actual text at the margin.
 199    =========================================================
 200
 201
 202 Tested Platforms
 203 ----------------
 204
 205 .. This section should contain a list of platforms that were tested
 206    with this release.
 207
 208    The format is:
 209
 210    * <vendor> platform with <vendor> <type of devices> combinations
 211
 212      * List of CPU
 213      * List of OS
 214      * List of devices
 215      * Other relevant details...
 216
 217    This section is a comment. Do not overwrite or remove it.
 218    Also, make sure to start the actual text at the margin.
 219    =========================================================