4 .. **Read this first.**
6 The text in the sections below explains how to update the release notes.
8 Use proper spelling, capitalization and punctuation in all sections.
10 Variable and config names should be quoted as fixed width text:
13 Build the docs and view the output file to ensure the changes are correct::
17 xdg-open build/doc/html/guides/rel_notes/release_18_08.html
23 .. This section should contain new features added in this release.
26 * **Add a title in the past tense with a full stop.**
28 Add a short 1-2 sentence description in the past tense.
29 The description should be enough to allow someone scanning
30 the release notes to understand the new feature.
32 If the feature adds a lot of sub-features you can use a bullet list
35 * Added feature foo to do something.
36 * Enhanced feature bar to do something else.
38 Refer to the previous release notes for examples.
40 This section is a comment. Do not overwrite or remove it.
41 Also, make sure to start the actual text at the margin.
42 =========================================================
48 .. This section should contain API changes. Sample format:
50 * Add a short 1-2 sentence description of the API change.
51 Use fixed width quotes for ``function_names`` or ``struct_names``.
54 This section is a comment. Do not overwrite or remove it.
55 Also, make sure to start the actual text at the margin.
56 =========================================================
62 .. This section should contain ABI changes. Sample format:
64 * Add a short 1-2 sentence description of the ABI change
65 that was announced in the previous releases and made in this release.
66 Use fixed width quotes for ``function_names`` or ``struct_names``.
69 This section is a comment. Do not overwrite or remove it.
70 Also, make sure to start the actual text at the margin.
71 =========================================================
77 .. This section should contain removed items in this release. Sample format:
79 * Add a short 1-2 sentence description of the removed item
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 =========================================================
87 Shared Library Versions
88 -----------------------
90 .. Update any library version updated in this release
91 and prepend with a ``+`` sign, like this:
97 This section is a comment. Do not overwrite or remove it.
98 =========================================================
100 The libraries prepended with a plus sign were incremented in this version.
106 librte_bitratestats.so.2
109 librte_bus_fslmc.so.1
114 librte_common_octeontx.so.1
115 librte_compressdev.so.1
116 librte_cryptodev.so.4
117 librte_distributor.so.1
121 librte_flow_classify.so.1
129 librte_latencystats.so.1
142 librte_pmd_ixgbe.so.2
143 librte_pmd_dpaa2_cmdif.so.1
144 librte_pmd_dpaa2_qdma.so.1
146 librte_pmd_softnic.so.1
147 librte_pmd_vhost.so.2
163 .. This section should contain new known issues in this release. Sample format:
165 * **Add title in present tense with full stop.**
167 Add a short 1-2 sentence description of the known issue
168 in the present tense. Add information on any known workarounds.
170 This section is a comment. Do not overwrite or remove it.
171 Also, make sure to start the actual text at the margin.
172 =========================================================
178 .. This section should contain a list of platforms that were tested
183 * <vendor> platform with <vendor> <type of devices> combinations
188 * Other relevant details...
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 =========================================================