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