1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2018 The DPDK contributors
7 .. **Read this first.**
9 The text in the sections below explains how to update the release notes.
11 Use proper spelling, capitalization and punctuation in all sections.
13 Variable and config names should be quoted as fixed width text:
16 Build the docs and view the output file to ensure the changes are correct::
20 xdg-open build/doc/html/guides/rel_notes/release_18_11.html
26 .. This section should contain new features added in this release.
29 * **Add a title in the past tense with a full stop.**
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.
35 If the feature adds a lot of sub-features you can use a bullet list
38 * Added feature foo to do something.
39 * Enhanced feature bar to do something else.
41 Refer to the previous release notes for examples.
43 Suggested order in release notes items:
44 * Core libs (EAL, mempool, ring, mbuf, buses)
45 * Device abstraction libs and PMDs
47 - cryptodev (lib, PMDs)
48 - eventdev (lib, PMDs)
51 * Apps, Examples, Tools (if significative)
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 =========================================================
57 * **Add support to offload more flow match and actions for CXGBE PMD**
59 Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
61 * Match items: destination MAC address.
62 * Action items: push/pop/rewrite vlan header.
64 * **Added a devarg to use the latest supported vector path in i40e.**
65 A new devarg ``use-latest-supported-vec`` was introduced to allow users to
66 choose the latest vector path that the platform supported. For example, users
67 can use AVX2 vector path on BDW/HSW to get better performance.
69 * **Added support for SR-IOV in netvsc PMD.**
71 The ``netvsc`` poll mode driver now supports the Accelerated Networking
72 SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
73 vdev_netvsc, tap, and failsafe drivers combination.
75 * **Updated failsafe driver.**
77 Updated the failsafe driver including the following changes:
79 * Support for Rx and Tx queues start and stop.
80 * Support for Rx and Tx queues deferred start.
81 * Support for runtime Rx queues setup.
83 * **Added ability to switch queue deferred start flag on testpmd app.**
85 Added a console command to testpmd app, giving ability to switch
86 ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
87 the specified port. The port must be stopped before the command call in order
88 to reconfigure queues.
94 .. This section should contain API changes. Sample format:
96 * Add a short 1-2 sentence description of the API change.
97 Use fixed width quotes for ``function_names`` or ``struct_names``.
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 =========================================================
104 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
105 functions were deprecated since 17.05 and are replaced by
106 ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
108 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
109 actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
110 support MAC changes once the port has started and with this new device
111 flag the MAC can be properly configured in any case. This is particularly
112 important for bonding.
118 .. This section should contain ABI changes. Sample format:
120 * Add a short 1-2 sentence description of the ABI change
121 that was announced in the previous releases and made in this release.
122 Use fixed width quotes for ``function_names`` or ``struct_names``.
125 This section is a comment. Do not overwrite or remove it.
126 Also, make sure to start the actual text at the margin.
127 =========================================================
133 .. This section should contain removed items in this release. Sample format:
135 * Add a short 1-2 sentence description of the removed item
138 This section is a comment. Do not overwrite or remove it.
139 Also, make sure to start the actual text at the margin.
140 =========================================================
143 Shared Library Versions
144 -----------------------
146 .. Update any library version updated in this release
147 and prepend with a ``+`` sign, like this:
150 + librte_cfgfile.so.2
153 This section is a comment. Do not overwrite or remove it.
154 =========================================================
156 The libraries prepended with a plus sign were incremented in this version.
162 librte_bitratestats.so.2
165 librte_bus_fslmc.so.1
168 + librte_bus_vmbus.so.1
171 librte_common_octeontx.so.1
172 librte_compressdev.so.1
173 librte_cryptodev.so.5
174 librte_distributor.so.1
178 librte_flow_classify.so.1
186 librte_latencystats.so.1
199 librte_pmd_ixgbe.so.2
200 librte_pmd_dpaa2_cmdif.so.1
201 librte_pmd_dpaa2_qdma.so.1
203 librte_pmd_softnic.so.1
204 librte_pmd_vhost.so.2
205 + librte_pmd_netvsc.so.1
221 .. This section should contain new known issues in this release. Sample format:
223 * **Add title in present tense with full stop.**
225 Add a short 1-2 sentence description of the known issue
226 in the present tense. Add information on any known workarounds.
228 This section is a comment. Do not overwrite or remove it.
229 Also, make sure to start the actual text at the margin.
230 =========================================================
232 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
233 driver; the Linux netvsc device must be brought up before the netvsc device is
234 unbound and passed to the DPDK.
240 .. This section should contain a list of platforms that were tested
245 * <vendor> platform with <vendor> <type of devices> combinations
250 * Other relevant details...
252 This section is a comment. Do not overwrite or remove it.
253 Also, make sure to start the actual text at the margin.
254 =========================================================