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