1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright 2023 The DPDK contributors 3 4.. include:: <isonum.txt> 5 6DPDK Release 24.03 7================== 8 9.. **Read this first.** 10 11 The text in the sections below explains how to update the release notes. 12 13 Use proper spelling, capitalization and punctuation in all sections. 14 15 Variable and config names should be quoted as fixed width text: 16 ``LIKE_THIS``. 17 18 Build the docs and view the output file to ensure the changes are correct:: 19 20 ninja -C build doc 21 xdg-open build/doc/guides/html/rel_notes/release_24_03.html 22 23 24New Features 25------------ 26 27.. This section should contain new features added in this release. 28 Sample format: 29 30 * **Add a title in the past tense with a full stop.** 31 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. 35 36 If the feature adds a lot of sub-features you can use a bullet list 37 like this: 38 39 * Added feature foo to do something. 40 * Enhanced feature bar to do something else. 41 42 Refer to the previous release notes for examples. 43 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) 47 - ethdev (lib, PMDs) 48 - cryptodev (lib, PMDs) 49 - eventdev (lib, PMDs) 50 - etc 51 * Other libs 52 * Apps, Examples, Tools (if significant) 53 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 ======================================================= 57 58* **Added HiSilicon UACCE bus support.** 59 60 UACCE (Unified/User-space-access-intended Accelerator Framework) bus driver 61 has been added, so that the accelerator devices could be seen in DPDK and could 62 be further registered such as a compress, crypto, DMA and ethernet devices. 63 64* **Introduced argument parsing library.** 65 66 The argparse library was added to ease writing user-friendly applications, 67 replacing ``getopt()`` usage. 68 69 70Removed Items 71------------- 72 73.. This section should contain removed items in this release. Sample format: 74 75 * Add a short 1-2 sentence description of the removed item 76 in the past tense. 77 78 This section is a comment. Do not overwrite or remove it. 79 Also, make sure to start the actual text at the margin. 80 ======================================================= 81 82* log: Removed the statically defined logtypes that were used internally by DPDK. 83 All code should be using the dynamic logtypes (see ``RTE_LOG_REGISTER()``). 84 The application reserved statically defined logtypes ``RTE_LOGTYPE_USER1..RTE_LOGTYPE_USER8`` 85 are still defined. 86 87 88API Changes 89----------- 90 91.. This section should contain API changes. Sample format: 92 93 * sample: Add a short 1-2 sentence description of the API change 94 which was announced in the previous releases and made in this release. 95 Start with a scope label like "ethdev:". 96 Use fixed width quotes for ``function_names`` or ``struct_names``. 97 Use the past tense. 98 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 ======================================================= 102 103* eal: Removed ``typeof(type)`` from the expansion of ``RTE_DEFINE_PER_LCORE`` 104 and ``RTE_DECLARE_PER_LCORE`` macros aligning them with their intended design. 105 If use with an expression is desired applications can adapt by supplying 106 ``typeof(e)`` as an argument. 107 108* eal: Improved ``RTE_BUILD_BUG_ON`` by using C11 ``static_assert``. 109 Non-constant expressions are now rejected instead of being silently ignored. 110 111* gso: ``rte_gso_segment`` now returns -ENOTSUP for unknown protocols. 112 113 114ABI Changes 115----------- 116 117.. This section should contain ABI changes. Sample format: 118 119 * sample: Add a short 1-2 sentence description of the ABI 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``. 123 Use the past tense. 124 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 ======================================================= 128 129* No ABI change that would break compatibility with 23.11. 130 131 132Known Issues 133------------ 134 135.. This section should contain new known issues in this release. Sample format: 136 137 * **Add title in present tense with full stop.** 138 139 Add a short 1-2 sentence description of the known issue 140 in the present tense. Add information on any known workarounds. 141 142 This section is a comment. Do not overwrite or remove it. 143 Also, make sure to start the actual text at the margin. 144 ======================================================= 145 146 147Tested Platforms 148---------------- 149 150.. This section should contain a list of platforms that were tested 151 with this release. 152 153 The format is: 154 155 * <vendor> platform with <vendor> <type of devices> combinations 156 157 * List of CPU 158 * List of OS 159 * List of devices 160 * Other relevant details... 161 162 This section is a comment. Do not overwrite or remove it. 163 Also, make sure to start the actual text at the margin. 164 ======================================================= 165