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 support for generic flow API (rte_flow) on igb NIC.**
46 This API provides a generic means to configure hardware to match specific
47 ingress or egress traffic, alter its behavior and query related counters
48 according to any number of user-defined rules.
50 * Generic flow API support for Ethernet, IPv4, UDP, TCP and
51 RAW pattern items with QUEUE actions. There are four
52 type of filter support for this feature on igb.
54 * **Added Generic Flow API support to enic.**
56 Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
57 and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
58 MARK, FLAG and VOID actions for ingress traffic.
60 * **Added support for Chelsio T6 family of adapters**
62 CXGBE PMD updated to run Chelsio T6 family of adapters.
64 * **Added latency and performance improvements for cxgbe**
66 TX and RX path reworked to improve performance. Also reduced latency
69 * **Updated bnxt PMD.**
71 Major enhancements include:
72 * Support MTU modification.
74 * Support VLAN filter and strip functionality.
75 * Other enhancements to add support for more dev_ops.
76 * Add PMD specific APIs mainly to control VF from PF.
77 * Update HWRM version to 1.7.7
79 * **Added support for Rx interrupts on mlx4 driver.**
81 Rx queues can be armed with an interrupt which will trigger on the
84 * **Updated szedata2 PMD.**
86 Added support for firmwares with multiple Ethernet ports per physical port.
92 .. This section should contain bug fixes added to the relevant
93 sections. Sample format:
95 * **code/section Fixed issue in the past tense with a full stop.**
97 Add a short 1-2 sentence description of the resolved issue in the past
100 The title should contain the code/lib section like a commit message.
102 Add the entries in alphabetic order in the relevant sections below.
104 This section is a comment. do not overwrite or remove it.
105 Also, make sure to start the actual text at the margin.
106 =========================================================
132 .. This section should contain new known issues in this release. Sample format:
134 * **Add title in present tense with full stop.**
136 Add a short 1-2 sentence description of the known issue in the present
137 tense. Add information on any known workarounds.
139 This section is a comment. do not overwrite or remove it.
140 Also, make sure to start the actual text at the margin.
141 =========================================================
147 .. This section should contain API changes. Sample format:
149 * Add a short 1-2 sentence description of the API change. Use fixed width
150 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
153 This section is a comment. do not overwrite or remove it.
154 Also, make sure to start the actual text at the margin.
155 =========================================================
161 .. This section should contain ABI changes. Sample format:
163 * Add a short 1-2 sentence description of the ABI change that was announced
164 in the previous releases and made in this release. Use fixed width quotes
165 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
167 This section is a comment. do not overwrite or remove it.
168 Also, make sure to start the actual text at the margin.
169 =========================================================
173 Shared Library Versions
174 -----------------------
176 .. Update any library version updated in this release and prepend with a ``+``
180 + librte_cfgfile.so.2
183 This section is a comment. do not overwrite or remove it.
184 =========================================================
187 The libraries prepended with a plus sign were incremented in this version.
192 librte_bitratestats.so.1
195 librte_cryptodev.so.2
196 librte_distributor.so.1
204 librte_latencystats.so.1
228 .. This section should contain a list of platforms that were tested with this
233 * <vendor> platform with <vendor> <type of devices> combinations
238 * Other relevant details...
240 This section is a comment. do not overwrite or remove it.
241 Also, make sure to start the actual text at the margin.
242 =========================================================