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 =========================================================
75 .. This section should contain ABI changes. Sample format:
77 * Add a short 1-2 sentence description of the ABI change
78 that was announced in the previous releases and made in this release.
79 Use fixed width quotes for ``function_names`` or ``struct_names``.
82 This section is a comment. Do not overwrite or remove it.
83 Also, make sure to start the actual text at the margin.
84 =========================================================
90 .. This section should contain removed items in this release. Sample format:
92 * Add a short 1-2 sentence description of the removed item
95 This section is a comment. Do not overwrite or remove it.
96 Also, make sure to start the actual text at the margin.
97 =========================================================
100 Shared Library Versions
101 -----------------------
103 .. Update any library version updated in this release
104 and prepend with a ``+`` sign, like this:
107 + librte_cfgfile.so.2
110 This section is a comment. Do not overwrite or remove it.
111 =========================================================
113 The libraries prepended with a plus sign were incremented in this version.
119 librte_bitratestats.so.2
122 librte_bus_fslmc.so.1
125 librte_bus_vmbus.so.1
128 librte_common_octeontx.so.1
129 librte_compressdev.so.1
130 librte_cryptodev.so.5
131 librte_distributor.so.1
135 librte_flow_classify.so.1
143 librte_latencystats.so.1
156 librte_pmd_ixgbe.so.2
157 librte_pmd_dpaa2_cmdif.so.1
158 librte_pmd_dpaa2_qdma.so.1
160 librte_pmd_softnic.so.1
161 librte_pmd_vhost.so.2
177 .. This section should contain new known issues in this release. Sample format:
179 * **Add title in present tense with full stop.**
181 Add a short 1-2 sentence description of the known issue
182 in the present tense. Add information on any known workarounds.
184 This section is a comment. Do not overwrite or remove it.
185 Also, make sure to start the actual text at the margin.
186 =========================================================
192 .. This section should contain a list of platforms that were tested
197 * <vendor> platform with <vendor> <type of devices> combinations
202 * Other relevant details...
204 This section is a comment. Do not overwrite or remove it.
205 Also, make sure to start the actual text at the margin.
206 =========================================================