1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2021 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::
21 xdg-open build/doc/html/guides/rel_notes/release_21_11.html
27 .. This section should contain new features added in this release.
30 * **Add a title in the past tense with a full stop.**
32 Add a short 1-2 sentence description in the past tense.
33 The description should be enough to allow someone scanning
34 the release notes to understand the new feature.
36 If the feature adds a lot of sub-features you can use a bullet list
39 * Added feature foo to do something.
40 * Enhanced feature bar to do something else.
42 Refer to the previous release notes for examples.
44 Suggested order in release notes items:
45 * Core libs (EAL, mempool, ring, mbuf, buses)
46 * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
48 - cryptodev (lib, PMDs)
49 - eventdev (lib, PMDs)
52 * Apps, Examples, Tools (if significant)
54 This section is a comment. Do not overwrite or remove it.
55 Also, make sure to start the actual text at the margin.
56 =======================================================
58 * **Enabled new devargs parser.**
60 * Enabled devargs syntax
61 ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
62 * Added bus-level parsing of the devargs syntax.
63 * Kept compatibility with the legacy syntax as parsing fallback.
65 * **Updated Marvell cnxk crypto PMD.**
67 * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
68 * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
69 * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
70 * Added support for lookaside protocol (IPsec) offload for CN9K.
72 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
74 * Added event crypto adapter OP_FORWARD mode support.
80 .. This section should contain removed items in this release. Sample format:
82 * Add a short 1-2 sentence description of the removed item
85 This section is a comment. Do not overwrite or remove it.
86 Also, make sure to start the actual text at the margin.
87 =======================================================
93 .. This section should contain API changes. Sample format:
95 * sample: Add a short 1-2 sentence description of the API change
96 which was announced in the previous releases and made in this release.
97 Start with a scope label like "ethdev:".
98 Use fixed width quotes for ``function_names`` or ``struct_names``.
101 This section is a comment. Do not overwrite or remove it.
102 Also, make sure to start the actual text at the margin.
103 =======================================================
105 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
106 rte_cryptodev_is_valid_dev as it can be used by the application as
107 well as PMD to check whether the device is valid or not.
113 .. This section should contain ABI changes. Sample format:
115 * sample: Add a short 1-2 sentence description of the ABI change
116 which was announced in the previous releases and made in this release.
117 Start with a scope label like "ethdev:".
118 Use fixed width quotes for ``function_names`` or ``struct_names``.
121 This section is a comment. Do not overwrite or remove it.
122 Also, make sure to start the actual text at the margin.
123 =======================================================
129 .. This section should contain new known issues in this release. Sample format:
131 * **Add title in present tense with full stop.**
133 Add a short 1-2 sentence description of the known issue
134 in the present tense. Add information on any known workarounds.
136 This section is a comment. Do not overwrite or remove it.
137 Also, make sure to start the actual text at the margin.
138 =======================================================
144 .. This section should contain a list of platforms that were tested
149 * <vendor> platform with <vendor> <type of devices> combinations
154 * Other relevant details...
156 This section is a comment. Do not overwrite or remove it.
157 Also, make sure to start the actual text at the margin.
158 =======================================================