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 * Action items: push/pop/rewrite vlan header.
67 .. This section should contain API changes. Sample format:
69 * Add a short 1-2 sentence description of the API change.
70 Use fixed width quotes for ``function_names`` or ``struct_names``.
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 =========================================================
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.
87 .. This section should contain ABI changes. Sample format:
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``.
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 =========================================================
102 .. This section should contain removed items in this release. Sample format:
104 * Add a short 1-2 sentence description of the removed item
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 =========================================================
112 Shared Library Versions
113 -----------------------
115 .. Update any library version updated in this release
116 and prepend with a ``+`` sign, like this:
119 + librte_cfgfile.so.2
122 This section is a comment. Do not overwrite or remove it.
123 =========================================================
125 The libraries prepended with a plus sign were incremented in this version.
131 librte_bitratestats.so.2
134 librte_bus_fslmc.so.1
137 librte_bus_vmbus.so.1
140 librte_common_octeontx.so.1
141 librte_compressdev.so.1
142 librte_cryptodev.so.5
143 librte_distributor.so.1
147 librte_flow_classify.so.1
155 librte_latencystats.so.1
168 librte_pmd_ixgbe.so.2
169 librte_pmd_dpaa2_cmdif.so.1
170 librte_pmd_dpaa2_qdma.so.1
172 librte_pmd_softnic.so.1
173 librte_pmd_vhost.so.2
189 .. This section should contain new known issues in this release. Sample format:
191 * **Add title in present tense with full stop.**
193 Add a short 1-2 sentence description of the known issue
194 in the present tense. Add information on any known workarounds.
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 =========================================================
204 .. This section should contain a list of platforms that were tested
209 * <vendor> platform with <vendor> <type of devices> combinations
214 * Other relevant details...
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 =========================================================