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_17_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 =========================================================
48 .. This section should contain bug fixes added to the relevant
49 sections. Sample format:
51 * **code/section Fixed issue in the past tense with a full stop.**
53 Add a short 1-2 sentence description of the resolved issue in the past
56 The title should contain the code/lib section like a commit message.
58 Add the entries in alphabetic order in the relevant sections below.
60 This section is a comment. do not overwrite or remove it.
61 Also, make sure to start the actual text at the margin.
62 =========================================================
88 .. This section should contain new known issues in this release. Sample format:
90 * **Add title in present tense with full stop.**
92 Add a short 1-2 sentence description of the known issue in the present
93 tense. Add information on any known workarounds.
95 This section is a comment. do not overwrite or remove it.
96 Also, make sure to start the actual text at the margin.
97 =========================================================
103 .. This section should contain API changes. Sample format:
105 * Add a short 1-2 sentence description of the API change. Use fixed width
106 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
109 This section is a comment. do not overwrite or remove it.
110 Also, make sure to start the actual text at the margin.
111 =========================================================
117 .. This section should contain ABI changes. Sample format:
119 * Add a short 1-2 sentence description of the ABI change that was announced
120 in the previous releases and made in this release. Use fixed width quotes
121 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
123 This section is a comment. do not overwrite or remove it.
124 Also, make sure to start the actual text at the margin.
125 =========================================================
131 .. This section should contain removed items in this release. Sample format:
133 * Add a short 1-2 sentence description of the removed item in the past
136 This section is a comment. do not overwrite or remove it.
137 Also, make sure to start the actual text at the margin.
138 =========================================================
140 * KNI vhost support removed.
143 Shared Library Versions
144 -----------------------
146 .. Update any library version updated in this release and prepend with a ``+``
150 + librte_cfgfile.so.2
153 This section is a comment. do not overwrite or remove it.
154 =========================================================
157 The libraries prepended with a plus sign were incremented in this version.
164 librte_cryptodev.so.2
165 librte_distributor.so.1
195 .. This section should contain a list of platforms that were tested with this
200 * <vendor> platform with <vendor> <type of devices> combinations
205 * Other relevant details...
207 This section is a comment. do not overwrite or remove it.
208 Also, make sure to start the actual text at the margin.
209 =========================================================