1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2019 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_02.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 Wait Until Equal API.**
61 A new API has been added to wait for a memory location to be updated with a
62 16-bit, 32-bit, 64-bit value.
64 * **Updated Mellanox mlx5 driver.**
66 Updated Mellanox mlx5 driver with new features and improvements, including:
68 * Added support for RSS using L3/L4 source/destination only.
70 * **Added algorithms to cryptodev API.**
72 * Chacha20-Poly1305 AEAD algorithm can now be supported in cryptodev.
73 * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
74 asymmetric crypto library specifications.
75 * ECPM (Elliptic Curve Point Multiplication) is added to
76 asymmetric crypto library specifications.
78 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
80 Added handling of mixed algorithms in encrypted digest hash-cipher
81 (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
82 ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
83 Such algorithm combinations are not supported on GEN1/GEN2 hardware
84 and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
86 * **Updated the Intel QuickAssist Technology (QAT) symmetric crypto PMD.**
88 Added Chacha20-Poly1305 AEAD algorithm.
94 .. This section should contain removed items in this release. Sample format:
96 * Add a short 1-2 sentence description of the removed item
99 This section is a comment. Do not overwrite or remove it.
100 Also, make sure to start the actual text at the margin.
101 =========================================================
107 .. This section should contain API changes. Sample format:
109 * sample: Add a short 1-2 sentence description of the API change
110 which was announced in the previous releases and made in this release.
111 Start with a scope label like "ethdev:".
112 Use fixed width quotes for ``function_names`` or ``struct_names``.
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 ABI changes. Sample format:
125 * sample: Add a short 1-2 sentence description of the ABI change
126 which was announced in the previous releases and made in this release.
127 Start with a scope label like "ethdev:".
128 Use fixed width quotes for ``function_names`` or ``struct_names``.
131 This section is a comment. Do not overwrite or remove it.
132 Also, make sure to start the actual text at the margin.
133 =========================================================
135 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
141 .. This section should contain new known issues in this release. Sample format:
143 * **Add title in present tense with full stop.**
145 Add a short 1-2 sentence description of the known issue
146 in the present tense. Add information on any known workarounds.
148 This section is a comment. Do not overwrite or remove it.
149 Also, make sure to start the actual text at the margin.
150 =========================================================
156 .. This section should contain a list of platforms that were tested
161 * <vendor> platform with <vendor> <type of devices> combinations
166 * Other relevant details...
168 This section is a comment. Do not overwrite or remove it.
169 Also, make sure to start the actual text at the margin.
170 =========================================================