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.
50 * **Added support for Chelsio T6 family of adapters**
52 CXGBE PMD updated to run Chelsio T6 family of adapters.
54 * **Added latency and performance improvements for cxgbe**
56 TX and RX path reworked to improve performance. Also reduced latency
59 * **Updated bnxt PMD.**
61 Major enhancements include:
62 * Support MTU modification.
64 * Support VLAN filter and strip functionality.
65 * Other enhancements to add support for more dev_ops.
66 * Add PMD specific APIs mainly to control VF from PF.
67 * Update HWRM version to 1.7.7
73 .. This section should contain bug fixes added to the relevant
74 sections. Sample format:
76 * **code/section Fixed issue in the past tense with a full stop.**
78 Add a short 1-2 sentence description of the resolved issue in the past
81 The title should contain the code/lib section like a commit message.
83 Add the entries in alphabetic order in the relevant sections below.
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 =========================================================
113 .. This section should contain new known issues in this release. Sample format:
115 * **Add title in present tense with full stop.**
117 Add a short 1-2 sentence description of the known issue in the present
118 tense. Add information on any known workarounds.
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 =========================================================
128 .. This section should contain API changes. Sample format:
130 * Add a short 1-2 sentence description of the API change. Use fixed width
131 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
134 This section is a comment. do not overwrite or remove it.
135 Also, make sure to start the actual text at the margin.
136 =========================================================
142 .. This section should contain ABI changes. Sample format:
144 * Add a short 1-2 sentence description of the ABI change that was announced
145 in the previous releases and made in this release. Use fixed width quotes
146 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
148 This section is a comment. do not overwrite or remove it.
149 Also, make sure to start the actual text at the margin.
150 =========================================================
154 Shared Library Versions
155 -----------------------
157 .. Update any library version updated in this release and prepend with a ``+``
161 + librte_cfgfile.so.2
164 This section is a comment. do not overwrite or remove it.
165 =========================================================
168 The libraries prepended with a plus sign were incremented in this version.
173 librte_bitratestats.so.1
176 librte_cryptodev.so.2
177 librte_distributor.so.1
185 librte_latencystats.so.1
209 .. This section should contain a list of platforms that were tested with this
214 * <vendor> platform with <vendor> <type of devices> combinations
219 * Other relevant details...
221 This section is a comment. do not overwrite or remove it.
222 Also, make sure to start the actual text at the margin.
223 =========================================================