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 support for SR-IOV in netvsc PMD.**
66 The ``netvsc`` poll mode driver now supports the Accelerated Networking
67 SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
68 vdev_netvsc, tap, and failsafe drivers combination.
74 .. This section should contain API changes. Sample format:
76 * Add a short 1-2 sentence description of the API change.
77 Use fixed width quotes for ``function_names`` or ``struct_names``.
80 This section is a comment. Do not overwrite or remove it.
81 Also, make sure to start the actual text at the margin.
82 =========================================================
84 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
85 functions were deprecated since 17.05 and are replaced by
86 ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
88 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
89 actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
90 support MAC changes once the port has started and with this new device
91 flag the MAC can be properly configured in any case. This is particularly
92 important for bonding.
98 .. This section should contain ABI changes. Sample format:
100 * Add a short 1-2 sentence description of the ABI change
101 that was announced in the previous releases and made in this release.
102 Use fixed width quotes for ``function_names`` or ``struct_names``.
105 This section is a comment. Do not overwrite or remove it.
106 Also, make sure to start the actual text at the margin.
107 =========================================================
113 .. This section should contain removed items in this release. Sample format:
115 * Add a short 1-2 sentence description of the removed item
118 This section is a comment. Do not overwrite or remove it.
119 Also, make sure to start the actual text at the margin.
120 =========================================================
123 Shared Library Versions
124 -----------------------
126 .. Update any library version updated in this release
127 and prepend with a ``+`` sign, like this:
130 + librte_cfgfile.so.2
133 This section is a comment. Do not overwrite or remove it.
134 =========================================================
136 The libraries prepended with a plus sign were incremented in this version.
142 librte_bitratestats.so.2
145 librte_bus_fslmc.so.1
148 + librte_bus_vmbus.so.1
151 librte_common_octeontx.so.1
152 librte_compressdev.so.1
153 librte_cryptodev.so.5
154 librte_distributor.so.1
158 librte_flow_classify.so.1
166 librte_latencystats.so.1
179 librte_pmd_ixgbe.so.2
180 librte_pmd_dpaa2_cmdif.so.1
181 librte_pmd_dpaa2_qdma.so.1
183 librte_pmd_softnic.so.1
184 librte_pmd_vhost.so.2
185 + librte_pmd_netvsc.so.1
201 .. This section should contain new known issues in this release. Sample format:
203 * **Add title in present tense with full stop.**
205 Add a short 1-2 sentence description of the known issue
206 in the present tense. Add information on any known workarounds.
208 This section is a comment. Do not overwrite or remove it.
209 Also, make sure to start the actual text at the margin.
210 =========================================================
212 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
213 driver; the Linux netvsc device must be brought up before the netvsc device is
214 unbound and passed to the DPDK.
220 .. This section should contain a list of platforms that were tested
225 * <vendor> platform with <vendor> <type of devices> combinations
230 * Other relevant details...
232 This section is a comment. Do not overwrite or remove it.
233 Also, make sure to start the actual text at the margin.
234 =========================================================