doc/guides/rel_notes/release_18_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 DPDK Release 18.11
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_18_11.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significative)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57 * **Add support to offload more flow match and actions for CXGBE PMD**
  58
  59   Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
  60
  61   * Match items: destination MAC address.
  62   * Action items: push/pop/rewrite vlan header.
  63
  64
  65 API Changes
  66 -----------
  67
  68 .. This section should contain API changes. Sample format:
  69
  70    * Add a short 1-2 sentence description of the API change.
  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 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
  79   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
  80   support MAC changes once the port has started and with this new device
  81   flag the MAC can be properly configured in any case. This is particularly
  82   important for bonding.
  83
  84
  85 ABI Changes
  86 -----------
  87
  88 .. This section should contain ABI changes. Sample format:
  89
  90    * Add a short 1-2 sentence description of the ABI change
  91      that was announced in the previous releases and made in this release.
  92      Use fixed width quotes for ``function_names`` or ``struct_names``.
  93      Use 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 Removed Items
 101 -------------
 102
 103 .. This section should contain removed items in this release. Sample format:
 104
 105    * Add a short 1-2 sentence description of the removed item
 106      in the past tense.
 107
 108    This section is a comment. Do not overwrite or remove it.
 109    Also, make sure to start the actual text at the margin.
 110    =========================================================
 111
 112
 113 Shared Library Versions
 114 -----------------------
 115
 116 .. Update any library version updated in this release
 117    and prepend with a ``+`` sign, like this:
 118
 119      librte_acl.so.2
 120    + librte_cfgfile.so.2
 121      librte_cmdline.so.2
 122
 123    This section is a comment. Do not overwrite or remove it.
 124    =========================================================
 125
 126 The libraries prepended with a plus sign were incremented in this version.
 127
 128 .. code-block:: diff
 129
 130      librte_acl.so.2
 131      librte_bbdev.so.1
 132      librte_bitratestats.so.2
 133      librte_bpf.so.1
 134      librte_bus_dpaa.so.1
 135      librte_bus_fslmc.so.1
 136      librte_bus_pci.so.1
 137      librte_bus_vdev.so.1
 138      librte_bus_vmbus.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.5
 144      librte_distributor.so.1
 145      librte_eal.so.8
 146      librte_ethdev.so.10
 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.5
 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    =========================================================
 220