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_18_02.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 the ixgbe ethernet driver to support RSS with flow API.**
46 Rte_flow actually defined to include RSS, but till now, RSS is out of
47 rte_flow. This patch is to support igb and ixgbe NIC with existing RSS
48 configuration using rte_flow API.
50 * **Add MAC loopback support for i40e.**
52 Add MAC loopback support for i40e in order to support test task asked by
53 users. According to the device configuration, it will setup TX->RX loopback
56 * **Add the support of run time determination of number of queues per i40e VF**
58 The number of queue per VF is determined by its host PF. If the PCI address
59 of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
60 with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
61 1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
62 per VF is 4 by default.
64 * **Added the i40e ethernet driver to support RSS with flow API.**
66 Rte_flow actually defined to include RSS, but till now, RSS is out of
67 rte_flow. This patch is to support i40e NIC with existing RSS
68 configuration using rte_flow API.It also enable queue region configuration
69 using flow API for i40e.
71 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
73 Added support for NVGRE, VXLAN and GENEVE tunnels.
75 * Added support for UDP tunnel ports configuration.
76 * Added tunneled packets classification.
77 * Added inner checksum offload.
79 * **Added the igb ethernet driver to support RSS with flow API.**
81 Rte_flow actually defined to include RSS, but till now, RSS is out of
82 rte_flow. This patch is to support igb NIC with existing RSS configuration
85 * **Add AVF (Adaptive Virtual Function) net PMD.**
87 A new net PMD has been added, which supports IntelĀ® Ethernet Adaptive
88 Virtual Function (AVF) with features list below:
91 * SSE vectorized Rx/Tx burst
96 * Jumbo frame and MTU setting
99 * Rx/Tx descriptor status
100 * Link status update/event
106 .. This section should contain API changes. Sample format:
108 * Add a short 1-2 sentence description of the API change. Use fixed width
109 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
112 This section is a comment. do not overwrite or remove it.
113 Also, make sure to start the actual text at the margin.
114 =========================================================
120 .. This section should contain ABI changes. Sample format:
122 * Add a short 1-2 sentence description of the ABI change that was announced
123 in the previous releases and made in this release. Use fixed width quotes
124 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
126 This section is a comment. do not overwrite or remove it.
127 Also, make sure to start the actual text at the margin.
128 =========================================================
134 .. This section should contain removed items in this release. Sample format:
136 * Add a short 1-2 sentence description of the removed item in the past
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 new known issues in this release. Sample format:
149 * **Add title in present tense with full stop.**
151 Add a short 1-2 sentence description of the known issue in the present
152 tense. Add information on any known workarounds.
154 This section is a comment. do not overwrite or remove it.
155 Also, make sure to start the actual text at the margin.
156 =========================================================
159 Shared Library Versions
160 -----------------------
162 .. Update any library version updated in this release and prepend with a ``+``
166 + librte_cfgfile.so.2
169 This section is a comment. do not overwrite or remove it.
170 =========================================================
173 The libraries prepended with a plus sign were incremented in this version.
178 librte_bitratestats.so.2
180 librte_bus_fslmc.so.1
185 librte_cryptodev.so.4
186 librte_distributor.so.1
190 librte_flow_classify.so.1
198 librte_latencystats.so.1
211 librte_pmd_ixgbe.so.2
213 librte_pmd_softnic.so.1
214 librte_pmd_vhost.so.2
230 .. This section should contain a list of platforms that were tested with this
235 * <vendor> platform with <vendor> <type of devices> combinations
240 * Other relevant details...
242 This section is a comment. do not overwrite or remove it.
243 Also, make sure to start the actual text at the margin.
244 =========================================================