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_05.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 =========================================================
44 * **Added RSS hash and key update to CXGBE PMD.**
46 Support to update RSS hash and key has been added to CXGBE PMD.
52 .. This section should contain API changes. Sample format:
54 * Add a short 1-2 sentence description of the API change. Use fixed width
55 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
58 This section is a comment. Do not overwrite or remove it.
59 Also, make sure to start the actual text at the margin.
60 =========================================================
66 .. This section should contain ABI changes. Sample format:
68 * Add a short 1-2 sentence description of the ABI change that was announced
69 in the previous releases and made in this release. Use fixed width quotes
70 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
72 This section is a comment. Do not overwrite or remove it.
73 Also, make sure to start the actual text at the margin.
74 =========================================================
80 .. This section should contain removed items in this release. Sample format:
82 * Add a short 1-2 sentence description of the removed item in the past
85 This section is a comment. Do not overwrite or remove it.
86 Also, make sure to start the actual text at the margin.
87 =========================================================
93 .. This section should contain new known issues in this release. Sample format:
95 * **Add title in present tense with full stop.**
97 Add a short 1-2 sentence description of the known issue in the present
98 tense. Add information on any known workarounds.
100 This section is a comment. Do not overwrite or remove it.
101 Also, make sure to start the actual text at the margin.
102 =========================================================
105 Shared Library Versions
106 -----------------------
108 .. Update any library version updated in this release and prepend with a ``+``
112 + librte_cfgfile.so.2
115 This section is a comment. Do not overwrite or remove it.
116 =========================================================
119 The libraries prepended with a plus sign were incremented in this version.
125 librte_bitratestats.so.2
127 librte_bus_fslmc.so.1
132 librte_cryptodev.so.4
133 librte_distributor.so.1
137 librte_flow_classify.so.1
145 librte_latencystats.so.1
158 librte_pmd_ixgbe.so.2
160 librte_pmd_softnic.so.1
161 librte_pmd_vhost.so.2
177 .. This section should contain a list of platforms that were tested with this
182 * <vendor> platform with <vendor> <type of devices> combinations
187 * Other relevant details...
189 This section is a comment. Do not overwrite or remove it.
190 Also, make sure to start the actual text at the margin.
191 =========================================================