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