4 .. **Read this first.**
6 The text 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: ``LIKE_THIS``.
12 Build the docs and view the output file to ensure the changes are correct::
16 firefox build/doc/html/guides/rel_notes/release_17_02.html
22 .. This section should contain new features added in this release. Sample format:
24 * **Add a title in the past tense with a full stop.**
26 Add a short 1-2 sentence description in the past tense. The description
27 should be enough to allow someone scanning the release notes to understand
30 If the feature adds a lot of sub-features you can use a bullet list like this.
32 * Added feature foo to do something.
33 * Enhanced feature bar to do something else.
35 Refer to the previous release notes for examples.
37 This section is a comment. do not overwrite or remove it.
38 Also, make sure to start the actual text at the margin.
39 =========================================================
45 .. This section should contain bug fixes added to the relevant sections. Sample format:
47 * **code/section Fixed issue in the past tense with a full stop.**
49 Add a short 1-2 sentence description of the resolved issue in the past tense.
50 The title should contain the code/lib section like a commit message.
51 Add the entries in alphabetic order in the relevant sections below.
53 This section is a comment. do not overwrite or remove it.
54 Also, make sure to start the actual text at the margin.
55 =========================================================
73 * **examples/ethtool: Fixed crash with non-PCI devices.**
75 Querying a non-PCI device was dereferencing non-existent PCI data
76 resulting in a segmentation fault.
86 .. This section should contain new known issues in this release. Sample format:
88 * **Add title in present tense with full stop.**
90 Add a short 1-2 sentence description of the known issue in the present
91 tense. Add information on any known workarounds.
93 This section is a comment. do not overwrite or remove it.
94 Also, make sure to start the actual text at the margin.
95 =========================================================
101 .. This section should contain API changes. Sample format:
103 * Add a short 1-2 sentence description of the API change. Use fixed width
104 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
106 This section is a comment. do not overwrite or remove it.
107 Also, make sure to start the actual text at the margin.
108 =========================================================
114 .. This section should contain ABI changes. Sample format:
116 * Add a short 1-2 sentence description of the ABI change that was announced in
117 the previous releases and made in this release. Use fixed width quotes for
118 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
120 This section is a comment. do not overwrite or remove it.
121 Also, make sure to start the actual text at the margin.
122 =========================================================
126 Shared Library Versions
127 -----------------------
129 .. Update any library version updated in this release and prepend with a ``+``
133 + librte_cfgfile.so.2
136 This section is a comment. do not overwrite or remove it.
137 =========================================================
140 The libraries prepended with a plus sign were incremented in this version.
147 librte_cryptodev.so.2
148 librte_distributor.so.1
178 .. This section should contain a list of platforms that were tested with this release.
187 This section is a comment. do not overwrite or remove it.
188 Also, make sure to start the actual text at the margin.
189 =========================================================
195 .. This section should contain a list of NICs that were tested with this release.
204 This section is a comment. do not overwrite or remove it.
205 Also, make sure to start the actual text at the margin.
206 =========================================================
212 .. This section should contain a list of OSes that were tested with this release.
213 The format is as follows, in alphabetical order:
219 * Red Hat Enterprise Linux 7.2
220 * SUSE Enterprise Linux 12
225 This section is a comment. do not overwrite or remove it.
226 Also, make sure to start the actual text at the margin.
227 =========================================================