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 =========================================================
44 * **Added Flow API support for CXGBE PMD.**
46 Flow API support has been added to CXGBE Poll Mode Driver to offload
47 flows to Chelsio T5/T6 NICs.
53 .. This section should contain API changes. Sample format:
55 * Add a short 1-2 sentence description of the API change.
56 Use fixed width quotes for ``function_names`` or ``struct_names``.
59 This section is a comment. Do not overwrite or remove it.
60 Also, make sure to start the actual text at the margin.
61 =========================================================
67 .. This section should contain ABI changes. Sample format:
69 * Add a short 1-2 sentence description of the ABI change
70 that was announced in the previous releases and made in this release.
71 Use fixed width quotes for ``function_names`` or ``struct_names``.
74 This section is a comment. Do not overwrite or remove it.
75 Also, make sure to start the actual text at the margin.
76 =========================================================
82 .. This section should contain removed items in this release. Sample format:
84 * Add a short 1-2 sentence description of the removed item
87 This section is a comment. Do not overwrite or remove it.
88 Also, make sure to start the actual text at the margin.
89 =========================================================
92 Shared Library Versions
93 -----------------------
95 .. Update any library version updated in this release
96 and prepend with a ``+`` sign, like this:
102 This section is a comment. Do not overwrite or remove it.
103 =========================================================
105 The libraries prepended with a plus sign were incremented in this version.
111 librte_bitratestats.so.2
114 librte_bus_fslmc.so.1
119 librte_common_octeontx.so.1
120 librte_compressdev.so.1
121 librte_cryptodev.so.4
122 librte_distributor.so.1
126 librte_flow_classify.so.1
134 librte_latencystats.so.1
147 librte_pmd_ixgbe.so.2
148 librte_pmd_dpaa2_cmdif.so.1
149 librte_pmd_dpaa2_qdma.so.1
151 librte_pmd_softnic.so.1
152 librte_pmd_vhost.so.2
168 .. This section should contain new known issues in this release. Sample format:
170 * **Add title in present tense with full stop.**
172 Add a short 1-2 sentence description of the known issue
173 in the present tense. Add information on any known workarounds.
175 This section is a comment. Do not overwrite or remove it.
176 Also, make sure to start the actual text at the margin.
177 =========================================================
183 .. This section should contain a list of platforms that were tested
188 * <vendor> platform with <vendor> <type of devices> combinations
193 * Other relevant details...
195 This section is a comment. Do not overwrite or remove it.
196 Also, make sure to start the actual text at the margin.
197 =========================================================