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_08.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 Generic Flow API support to enic.**
46 Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
47 and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
48 MARK, FLAG and VOID actions for ingress traffic.
54 .. This section should contain bug fixes added to the relevant
55 sections. Sample format:
57 * **code/section Fixed issue in the past tense with a full stop.**
59 Add a short 1-2 sentence description of the resolved issue in the past
62 The title should contain the code/lib section like a commit message.
64 Add the entries in alphabetic order in the relevant sections below.
66 This section is a comment. do not overwrite or remove it.
67 Also, make sure to start the actual text at the margin.
68 =========================================================
94 .. This section should contain new known issues in this release. Sample format:
96 * **Add title in present tense with full stop.**
98 Add a short 1-2 sentence description of the known issue in the present
99 tense. Add information on any known workarounds.
101 This section is a comment. do not overwrite or remove it.
102 Also, make sure to start the actual text at the margin.
103 =========================================================
109 .. This section should contain API changes. Sample format:
111 * Add a short 1-2 sentence description of the API change. Use fixed width
112 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
115 This section is a comment. do not overwrite or remove it.
116 Also, make sure to start the actual text at the margin.
117 =========================================================
123 .. This section should contain ABI changes. Sample format:
125 * Add a short 1-2 sentence description of the ABI change that was announced
126 in the previous releases and made in this release. Use fixed width quotes
127 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
129 This section is a comment. do not overwrite or remove it.
130 Also, make sure to start the actual text at the margin.
131 =========================================================
135 Shared Library Versions
136 -----------------------
138 .. Update any library version updated in this release and prepend with a ``+``
142 + librte_cfgfile.so.2
145 This section is a comment. do not overwrite or remove it.
146 =========================================================
149 The libraries prepended with a plus sign were incremented in this version.
154 librte_bitratestats.so.1
157 librte_cryptodev.so.2
158 librte_distributor.so.1
166 librte_latencystats.so.1
190 .. This section should contain a list of platforms that were tested with this
195 * <vendor> platform with <vendor> <type of devices> combinations
200 * Other relevant details...
202 This section is a comment. do not overwrite or remove it.
203 Also, make sure to start the actual text at the margin.
204 =========================================================