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