1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2020 The DPDK contributors
4 .. include:: <isonum.txt>
9 .. **Read this first.**
11 The text in the sections below explains how to update the release notes.
13 Use proper spelling, capitalization and punctuation in all sections.
15 Variable and config names should be quoted as fixed width text:
18 Build the docs and view the output file to ensure the changes are correct::
22 xdg-open build/doc/html/guides/rel_notes/release_20_05.html
28 .. This section should contain new features added in this release.
31 * **Add a title in the past tense with a full stop.**
33 Add a short 1-2 sentence description in the past tense.
34 The description should be enough to allow someone scanning
35 the release notes to understand the new feature.
37 If the feature adds a lot of sub-features you can use a bullet list
40 * Added feature foo to do something.
41 * Enhanced feature bar to do something else.
43 Refer to the previous release notes for examples.
45 Suggested order in release notes items:
46 * Core libs (EAL, mempool, ring, mbuf, buses)
47 * Device abstraction libs and PMDs
49 - cryptodev (lib, PMDs)
50 - eventdev (lib, PMDs)
53 * Apps, Examples, Tools (if significant)
55 This section is a comment. Do not overwrite or remove it.
56 Also, make sure to start the actual text at the margin.
57 =========================================================
59 * **Added new API for rte_ring.**
61 * New synchronization modes for rte_ring.
63 Introduced new optional MT synchronization modes for rte_ring:
64 Relaxed Tail Sync (RTS) mode and Head/Tail Sync (HTS) mode.
65 With these mode selected, rte_ring shows significant improvements for
66 average enqueue/dequeue times on overcommitted systems.
68 * Added peek style API for rte_ring.
70 For rings with producer/consumer in RTE_RING_SYNC_ST, RTE_RING_SYNC_MT_HTS
71 mode, provide an ability to split enqueue/dequeue operation into two phases
72 (enqueue/dequeue start; enqueue/dequeue finish). That allows user to inspect
73 objects in the ring without removing them from it (aka MT safe peek).
75 * **Updated Mellanox mlx5 driver.**
77 Updated Mellanox mlx5 driver with new features and improvements, including:
79 * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
81 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
83 Enabled handling of mixed algorithms in encrypted digest hash-cipher
84 (generation) and cipher-hash (verification) requests in QAT PMD
85 when running on GEN2 QAT hardware with particular firmware versions
86 (GEN3 support was added in DPDK 20.02).
88 * **Updated the turbo_sw bbdev PMD.**
90 Supported large size code blocks which does not fit in one mbuf segment.
92 * **Added event mode to ipsec-secgw application.**
94 Updated ipsec-secgw application to add event based packet processing. The worker
95 thread(s) would receive events and submit them back to the event device after
96 the processing. This way, multicore scaling and HW assisted scheduling is achieved
97 by making use of the event device capabilities. The event mode currently supports
98 only inline IPsec protocol offload.
104 .. This section should contain removed items in this release. Sample format:
106 * Add a short 1-2 sentence description of the removed item
109 This section is a comment. Do not overwrite or remove it.
110 Also, make sure to start the actual text at the margin.
111 =========================================================
117 .. This section should contain API changes. Sample format:
119 * sample: Add a short 1-2 sentence description of the API change
120 which was announced in the previous releases and made in this release.
121 Start with a scope label like "ethdev:".
122 Use fixed width quotes for ``function_names`` or ``struct_names``.
125 This section is a comment. Do not overwrite or remove it.
126 Also, make sure to start the actual text at the margin.
127 =========================================================
133 .. This section should contain ABI changes. Sample format:
135 * sample: Add a short 1-2 sentence description of the ABI change
136 which was announced in the previous releases and made in this release.
137 Start with a scope label like "ethdev:".
138 Use fixed width quotes for ``function_names`` or ``struct_names``.
141 This section is a comment. Do not overwrite or remove it.
142 Also, make sure to start the actual text at the margin.
143 =========================================================
145 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
151 .. This section should contain new known issues in this release. Sample format:
153 * **Add title in present tense with full stop.**
155 Add a short 1-2 sentence description of the known issue
156 in the present tense. Add information on any known workarounds.
158 This section is a comment. Do not overwrite or remove it.
159 Also, make sure to start the actual text at the margin.
160 =========================================================
166 .. This section should contain a list of platforms that were tested
171 * <vendor> platform with <vendor> <type of devices> combinations
176 * Other relevant details...
178 This section is a comment. Do not overwrite or remove it.
179 Also, make sure to start the actual text at the margin.
180 =========================================================