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 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
58 Added support for NVGRE, VXLAN and GENEVE tunnels.
60 * Added support for UDP tunnel ports configuration.
61 * Added tunneled packets classification.
62 * Added inner checksum offload.
64 * **Added the igb 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 igb NIC with existing RSS configuration
74 .. This section should contain API changes. Sample format:
76 * Add a short 1-2 sentence description of the API change. Use fixed width
77 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
80 This section is a comment. do not overwrite or remove it.
81 Also, make sure to start the actual text at the margin.
82 =========================================================
88 .. This section should contain ABI changes. Sample format:
90 * Add a short 1-2 sentence description of the ABI change that was announced
91 in the previous releases and made in this release. Use fixed width quotes
92 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
94 This section is a comment. do not overwrite or remove it.
95 Also, make sure to start the actual text at the margin.
96 =========================================================
102 .. This section should contain removed items in this release. Sample format:
104 * Add a short 1-2 sentence description of the removed item in the past
107 This section is a comment. do not overwrite or remove it.
108 Also, make sure to start the actual text at the margin.
109 =========================================================
115 .. This section should contain new known issues in this release. Sample format:
117 * **Add title in present tense with full stop.**
119 Add a short 1-2 sentence description of the known issue in the present
120 tense. Add information on any known workarounds.
122 This section is a comment. do not overwrite or remove it.
123 Also, make sure to start the actual text at the margin.
124 =========================================================
127 Shared Library Versions
128 -----------------------
130 .. Update any library version updated in this release and prepend with a ``+``
134 + librte_cfgfile.so.2
137 This section is a comment. do not overwrite or remove it.
138 =========================================================
141 The libraries prepended with a plus sign were incremented in this version.
146 librte_bitratestats.so.2
148 librte_bus_fslmc.so.1
153 librte_cryptodev.so.4
154 librte_distributor.so.1
158 librte_flow_classify.so.1
166 librte_latencystats.so.1
179 librte_pmd_ixgbe.so.2
181 librte_pmd_softnic.so.1
182 librte_pmd_vhost.so.2
198 .. This section should contain a list of platforms that were tested with this
203 * <vendor> platform with <vendor> <type of devices> combinations
208 * Other relevant details...
210 This section is a comment. do not overwrite or remove it.
211 Also, make sure to start the actual text at the margin.
212 =========================================================