Skip to content

Commit 71a4b33

Browse files
john-mcnamara-inteltmonjalo
authored andcommitted
doc: update release notes for 25.03
Fix grammar, spelling and formatting of DPDK 25.03 release notes Signed-off-by: John McNamara <[email protected]> Signed-off-by: Thomas Monjalon <[email protected]>
1 parent 7642e3b commit 71a4b33

File tree

1 file changed

+17
-130
lines changed

1 file changed

+17
-130
lines changed

doc/guides/rel_notes/release_25_03.rst

Lines changed: 17 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -6,64 +6,18 @@
66
DPDK Release 25.03
77
==================
88

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_25_03.html
22-
23-
249
New Features
2510
------------
2611

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-
5812
* **Added Staged-Ordered-Ring (SORING) API to the ring library.**
5913

60-
New API was added to the ring library to provide a SW abstraction
14+
Added new API to the ring library to provide a software abstraction
6115
for ordered queues with multiple processing stages.
62-
It is based on conventional DPDK rte_ring, re-uses many of its concepts,
63-
and even substantial part of its code.
64-
It can be viewed as an extension of rte_ring functionality.
16+
It is based on the conventional DPDK ``rte_ring`` and re-uses many of its concepts,
17+
including substantial part of its code.
18+
It can be viewed as an extension of ``rte_ring`` functionality.
6519

66-
* **Hardened of more allocation functions.**
20+
* **Hardened more allocation functions.**
6721

6822
Added allocation attributes to functions that allocate data:
6923

@@ -89,12 +43,12 @@ New Features
8943

9044
This can catch some obvious bugs at compile time (with GCC 11.0 or later).
9145
For example, calling ``free`` on a pointer that was allocated with one
92-
of those functions (and vice versa); freeing the same pointer twice
46+
of those functions (and vice versa), freeing the same pointer twice
9347
in the same routine or freeing an object that was not created by allocation.
9448

9549
* **Updated af_packet net driver.**
9650

97-
* Added ability to option to configure receive packet fanout mode.
51+
* Added ability to configure receive packet fanout mode.
9852
* Added statistics for failed buffer allocation and missed packets.
9953

10054
* **Updated Amazon ENA (Elastic Network Adapter) net driver.**
@@ -129,7 +83,7 @@ New Features
12983
* **Updated NVIDIA mlx5 driver.**
13084

13185
* Added support for NVIDIA ConnectX-8 adapters.
132-
* Optimized port probing in large scale.
86+
* Optimized large scale port probing.
13387
This feature enhances the efficiency of probing VF/SFs on a large scale
13488
by significantly reducing the probing time.
13589

@@ -157,13 +111,10 @@ New Features
157111

158112
Added network driver for the Yunsilicon metaScale serials NICs.
159113

160-
* **Updated vhost library.**
114+
* **Updated vhost/virtio for RSA crypto.**
161115

162-
Updated vhost library to support RSA crypto operations.
163-
164-
* **Updated virtio crypto driver.**
165-
166-
* Added support for RSA crypto operations.
116+
* Added RSA crypto operations to the vhost library.
117+
* Added RSA crypto operations to the virtio crypto driver.
167118

168119
* **Updated IPsec_MB crypto driver.**
169120

@@ -179,24 +130,15 @@ New Features
179130
* **Added atomic tests to the eventdev test application.**
180131

181132
Added two atomic tests: ``atomic_queue`` and ``atomic_atq``.
182-
They work in the same way as the corresponding ordered tests
183-
but exclusively use atomic queues.
133+
These work in the same way as the corresponding ordered tests
134+
but use atomic queues exclusively.
184135
Atomicity is verified using spinlocks.
185136

186137

187138
Removed Items
188139
-------------
189140

190-
.. This section should contain removed items in this release. Sample format:
191-
192-
* Add a short 1-2 sentence description of the removed item
193-
in the past tense.
194-
195-
This section is a comment. Do not overwrite or remove it.
196-
Also, make sure to start the actual text at the margin.
197-
=======================================================
198-
199-
* **Dropped support for Intel\ |reg| C++ Compiler (icc) (replaced by "icx" support)**
141+
* **Dropped support for Intel\ |reg| C++ Compiler (icc) (replaced by "icx" support).**
200142

201143
Support for the older Intel\ |reg| C++ Compiler "icc" has been dropped.
202144
The newer Intel\ |reg| oneAPI DPC++/C++ Compiler, "icx", can be used to compile DPDK instead.
@@ -205,18 +147,6 @@ Removed Items
205147
API Changes
206148
-----------
207149

208-
.. This section should contain API changes. Sample format:
209-
210-
* sample: Add a short 1-2 sentence description of the API change
211-
which was announced in the previous releases and made in this release.
212-
Start with a scope label like "ethdev:".
213-
Use fixed width quotes for ``function_names`` or ``struct_names``.
214-
Use the past tense.
215-
216-
This section is a comment. Do not overwrite or remove it.
217-
Also, make sure to start the actual text at the margin.
218-
=======================================================
219-
220150
* eal: The ``__rte_packed`` macro for packing data is replaced with
221151
``__rte_packed_begin`` / ``__rte_packed_end``.
222152

@@ -233,12 +163,12 @@ API Changes
233163
cpfl, e1000, fm10k, i40e, iavf, ice, idpf, ipn3ke and ixgbe,
234164
have been moved from ``drivers/net`` to a new ``drivers/net/intel`` directory.
235165
The resulting build output, including the driver filenames, is the same,
236-
but to enable/disable these drivers via Meson option requires use of the new paths.
166+
but to enable/disable these drivers via Meson option requires the use of the new paths.
237167
For example, ``-Denable_drivers=/net/i40e`` becomes ``-Denable_drivers=/net/intel/i40e``.
238168

239-
* build: The Intel IGC networking driver was merged with e1000 driver
169+
* build: The Intel IGC networking driver was merged with the e1000 driver
240170
and is no longer provided as a separate driver.
241-
The resulting build output will not have the ``librte_net_igc.*`` driver files any more,
171+
The resulting build output will no longer have the ``librte_net_igc.*`` driver files,
242172
but the ``librte_net_e1000.*`` driver files will provide support
243173
for all of the devices and features of the old driver.
244174
In addition, to enable/disable the driver via Meson option,
@@ -258,55 +188,12 @@ API Changes
258188
ABI Changes
259189
-----------
260190

261-
.. This section should contain ABI changes. Sample format:
262-
263-
* sample: Add a short 1-2 sentence description of the ABI change
264-
which was announced in the previous releases and made in this release.
265-
Start with a scope label like "ethdev:".
266-
Use fixed width quotes for ``function_names`` or ``struct_names``.
267-
Use the past tense.
268-
269-
This section is a comment. Do not overwrite or remove it.
270-
Also, make sure to start the actual text at the margin.
271-
=======================================================
272-
273191
* No ABI change that would break compatibility with 24.11.
274192

275193

276-
Known Issues
277-
------------
278-
279-
.. This section should contain new known issues in this release. Sample format:
280-
281-
* **Add title in present tense with full stop.**
282-
283-
Add a short 1-2 sentence description of the known issue
284-
in the present tense. Add information on any known workarounds.
285-
286-
This section is a comment. Do not overwrite or remove it.
287-
Also, make sure to start the actual text at the margin.
288-
=======================================================
289-
290-
291194
Tested Platforms
292195
----------------
293196

294-
.. This section should contain a list of platforms that were tested
295-
with this release.
296-
297-
The format is:
298-
299-
* <vendor> platform with <vendor> <type of devices> combinations
300-
301-
* List of CPU
302-
* List of OS
303-
* List of devices
304-
* Other relevant details...
305-
306-
This section is a comment. Do not overwrite or remove it.
307-
Also, make sure to start the actual text at the margin.
308-
=======================================================
309-
310197
* Intel\ |reg| platforms with Intel\ |reg| NICs combinations
311198

312199
* CPU

0 commit comments

Comments
 (0)