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 NVGRE and UDP tunnels support in Solarflare network PMD.**
66 Added support for NVGRE, VXLAN and GENEVE tunnels.
68 * Added support for UDP tunnel ports configuration.
69 * Added tunneled packets classification.
70 * Added inner checksum offload.
72 * **Added the igb ethernet driver to support RSS with flow API.**
74 Rte_flow actually defined to include RSS, but till now, RSS is out of
75 rte_flow. This patch is to support igb NIC with existing RSS configuration
82 .. This section should contain API changes. Sample format:
84 * Add a short 1-2 sentence description of the API change. Use fixed width
85 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
88 This section is a comment. do not overwrite or remove it.
89 Also, make sure to start the actual text at the margin.
90 =========================================================
96 .. This section should contain ABI changes. Sample format:
98 * Add a short 1-2 sentence description of the ABI change that was announced
99 in the previous releases and made in this release. Use fixed width quotes
100 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
102 This section is a comment. do not overwrite or remove it.
103 Also, make sure to start the actual text at the margin.
104 =========================================================
110 .. This section should contain removed items in this release. Sample format:
112 * Add a short 1-2 sentence description of the removed item in 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 new known issues in this release. Sample format:
125 * **Add title in present tense with full stop.**
127 Add a short 1-2 sentence description of the known issue in the present
128 tense. Add information on any known workarounds.
130 This section is a comment. do not overwrite or remove it.
131 Also, make sure to start the actual text at the margin.
132 =========================================================
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.2
156 librte_bus_fslmc.so.1
161 librte_cryptodev.so.4
162 librte_distributor.so.1
166 librte_flow_classify.so.1
174 librte_latencystats.so.1
187 librte_pmd_ixgbe.so.2
189 librte_pmd_softnic.so.1
190 librte_pmd_vhost.so.2
206 .. This section should contain a list of platforms that were tested with this
211 * <vendor> platform with <vendor> <type of devices> combinations
216 * Other relevant details...
218 This section is a comment. do not overwrite or remove it.
219 Also, make sure to start the actual text at the margin.
220 =========================================================