1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2019 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_19_08.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 significant)
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 removed items in this release. Sample format:
63 * Add a short 1-2 sentence description of the removed item
66 This section is a comment. Do not overwrite or remove it.
67 Also, make sure to start the actual text at the margin.
68 =========================================================
74 .. This section should contain API changes. Sample format:
76 * sample: Add a short 1-2 sentence description of the API change
77 which was announced in the previous releases and made in this release.
78 Start with a scope label like "ethdev:".
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 =========================================================
86 * The network structures, definitions and functions have
87 been prefixed by ``rte_`` to resolve conflicts with libc headers.
93 .. This section should contain ABI changes. Sample format:
95 * sample: Add a short 1-2 sentence description of the ABI change
96 which was announced in the previous releases and made in this release.
97 Start with a scope label like "ethdev:".
98 Use fixed width quotes for ``function_names`` or ``struct_names``.
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:
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.2
129 librte_bus_ifpga.so.2
132 librte_bus_vmbus.so.2
135 librte_compressdev.so.1
136 librte_cryptodev.so.7
137 librte_distributor.so.1
142 librte_flow_classify.so.1
151 librte_latencystats.so.1
165 librte_pmd_ixgbe.so.2
166 librte_pmd_dpaa2_qdma.so.1
168 librte_pmd_softnic.so.1
169 librte_pmd_vhost.so.2
187 .. This section should contain new known issues in this release. Sample format:
189 * **Add title in present tense with full stop.**
191 Add a short 1-2 sentence description of the known issue
192 in the present tense. Add information on any known workarounds.
194 This section is a comment. Do not overwrite or remove it.
195 Also, make sure to start the actual text at the margin.
196 =========================================================
202 .. This section should contain a list of platforms that were tested
207 * <vendor> platform with <vendor> <type of devices> combinations
212 * Other relevant details...
214 This section is a comment. Do not overwrite or remove it.
215 Also, make sure to start the actual text at the margin.
216 =========================================================