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_02.html
23 .. This section should contain new features added in this release. Sample
26 * **Add a title in the past tense with a full stop.**
28 Add a short 1-2 sentence description in the past tense. The description
29 should be enough to allow someone scanning the release notes to
30 understand the new feature.
32 If the feature adds a lot of sub-features you can use a bullet list like
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. Use fixed width
51 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
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 that was announced
65 in the previous releases and made in this release. Use fixed width quotes
66 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
68 This section is a comment. do not overwrite or remove it.
69 Also, make sure to start the actual text at the margin.
70 =========================================================
76 .. This section should contain removed items in this release. Sample format:
78 * Add a short 1-2 sentence description of the removed item in the past
81 This section is a comment. do not overwrite or remove it.
82 Also, make sure to start the actual text at the margin.
83 =========================================================
89 .. This section should contain new known issues in this release. Sample format:
91 * **Add title in present tense with full stop.**
93 Add a short 1-2 sentence description of the known issue in the present
94 tense. Add information on any known workarounds.
96 This section is a comment. do not overwrite or remove it.
97 Also, make sure to start the actual text at the margin.
98 =========================================================
101 Shared Library Versions
102 -----------------------
104 .. Update any library version updated in this release and prepend with a ``+``
108 + librte_cfgfile.so.2
111 This section is a comment. do not overwrite or remove it.
112 =========================================================
115 The libraries prepended with a plus sign were incremented in this version.
120 librte_bitratestats.so.2
122 librte_bus_fslmc.so.1
127 librte_cryptodev.so.4
128 librte_distributor.so.1
132 librte_flow_classify.so.1
140 librte_latencystats.so.1
153 librte_pmd_ixgbe.so.2
155 librte_pmd_softnic.so.1
156 librte_pmd_vhost.so.2
172 .. This section should contain a list of platforms that were tested with this
177 * <vendor> platform with <vendor> <type of devices> combinations
182 * Other relevant details...
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 =========================================================