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 =========================================================
61 .. This section should contain API changes. Sample format:
63 * Add a short 1-2 sentence description of the API change.
64 Use fixed width quotes for ``function_names`` or ``struct_names``.
67 This section is a comment. Do not overwrite or remove it.
68 Also, make sure to start the actual text at the margin.
69 =========================================================
71 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
72 actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
73 support MAC changes once the port has started and with this new device
74 flag the MAC can be properly configured in any case. This is particularly
75 important for bonding.
81 .. This section should contain ABI changes. Sample format:
83 * Add a short 1-2 sentence description of the ABI change
84 that was announced in the previous releases and made in this release.
85 Use fixed width quotes for ``function_names`` or ``struct_names``.
88 This section is a comment. Do not overwrite or remove it.
89 Also, make sure to start the actual text at the margin.
90 =========================================================
96 .. This section should contain removed items in this release. Sample format:
98 * Add a short 1-2 sentence description of the removed item
101 This section is a comment. Do not overwrite or remove it.
102 Also, make sure to start the actual text at the margin.
103 =========================================================
106 Shared Library Versions
107 -----------------------
109 .. Update any library version updated in this release
110 and prepend with a ``+`` sign, like this:
113 + librte_cfgfile.so.2
116 This section is a comment. Do not overwrite or remove it.
117 =========================================================
119 The libraries prepended with a plus sign were incremented in this version.
125 librte_bitratestats.so.2
128 librte_bus_fslmc.so.1
131 librte_bus_vmbus.so.1
134 librte_common_octeontx.so.1
135 librte_compressdev.so.1
136 librte_cryptodev.so.5
137 librte_distributor.so.1
141 librte_flow_classify.so.1
149 librte_latencystats.so.1
162 librte_pmd_ixgbe.so.2
163 librte_pmd_dpaa2_cmdif.so.1
164 librte_pmd_dpaa2_qdma.so.1
166 librte_pmd_softnic.so.1
167 librte_pmd_vhost.so.2
183 .. This section should contain new known issues in this release. Sample format:
185 * **Add title in present tense with full stop.**
187 Add a short 1-2 sentence description of the known issue
188 in the present tense. Add information on any known workarounds.
190 This section is a comment. Do not overwrite or remove it.
191 Also, make sure to start the actual text at the margin.
192 =========================================================
198 .. This section should contain a list of platforms that were tested
203 * <vendor> platform with <vendor> <type of devices> combinations
208 * Other relevant details...
210 This section is a comment. Do not overwrite or remove it.
211 Also, make sure to start the actual text at the margin.
212 =========================================================