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_08.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 * **Added auxiliary bus support.**
60 Auxiliary bus provides a way to split function into child-devices
61 representing sub-domains of functionality. Each auxiliary device
62 represents a part of its parent functionality.
68 .. This section should contain removed items in this release. Sample format:
70 * Add a short 1-2 sentence description of the removed item
73 This section is a comment. Do not overwrite or remove it.
74 Also, make sure to start the actual text at the margin.
75 =======================================================
81 .. This section should contain API changes. Sample format:
83 * sample: Add a short 1-2 sentence description of the API change
84 which was announced in the previous releases and made in this release.
85 Start with a scope label like "ethdev:".
86 Use fixed width quotes for ``function_names`` or ``struct_names``.
89 This section is a comment. Do not overwrite or remove it.
90 Also, make sure to start the actual text at the margin.
91 =======================================================
93 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
100 .. This section should contain ABI changes. Sample format:
102 * sample: Add a short 1-2 sentence description of the ABI change
103 which was announced in the previous releases and made in this release.
104 Start with a scope label like "ethdev:".
105 Use fixed width quotes for ``function_names`` or ``struct_names``.
108 This section is a comment. Do not overwrite or remove it.
109 Also, make sure to start the actual text at the margin.
110 =======================================================
112 * No ABI change that would break compatibility with 20.11.
118 .. This section should contain new known issues in this release. Sample format:
120 * **Add title in present tense with full stop.**
122 Add a short 1-2 sentence description of the known issue
123 in the present tense. Add information on any known workarounds.
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 a list of platforms that were tested
138 * <vendor> platform with <vendor> <type of devices> combinations
143 * Other relevant details...
145 This section is a comment. Do not overwrite or remove it.
146 Also, make sure to start the actual text at the margin.
147 =======================================================