d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: remove template comments in old release notes

Browse Source 
The release notes comments mention how to generate the documentation
with the old & removed build system.

Rather than fixing these comments, all old release notes comments
are removed, because they are useful only for the current release.

Few extra blank lines are removed for consistency.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: David Marchand <david.marchand@redhat.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
This commit is contained in:
Thomas Monjalon 2021-09-15 18:25:09 +02:00
parent 7a33572057
commit 6d124f592c
24 changed files with 0 additions and 2104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/guides/rel_notes/release_16_04.rst
View File

@ -4,7 +4,6 @@
DPDK Release 16.04
==================
New Features
------------

90
doc/guides/rel_notes/release_16_07.rst
View File

@ -4,39 +4,9 @@
DPDK Release 16.07
==================
.. **Read this first.**
The text below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
firefox build/doc/html/guides/rel_notes/release_16_07.html
New Features
------------
.. This section should contain new features added in this release. Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense. The description
should be enough to allow someone scanning the release notes to understand
the new feature.
If the feature adds a lot of sub-features you can use a bullet list like this.
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
* **Removed the mempool cache memory if caching is not being used.**
The size of the mempool structure is reduced if the per-lcore cache is disabled.
@ -217,15 +187,6 @@ New Features
Resolved Issues
---------------
.. This section should contain bug fixes added to the relevant sections. Sample format:
* **code/section Fixed issue in the past tense with a full stop.**
Add a short 1-2 sentence description of the resolved issue in the past tense.
The title should contain the code/lib section like a commit message.
Add the entries in alphabetic order in the relevant sections below.
EAL
~~~
@ -289,33 +250,9 @@ Libraries
counter. This lead to a memory leak of the direct mbuf.
Examples
~~~~~~~~
Other
~~~~~
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue in the present
tense. Add information on any known workarounds.
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change. Use fixed width
quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
* The following counters are removed from the ``rte_eth_stats`` structure:
* ``ibadcrc``
@ -354,10 +291,6 @@ API Changes
ABI Changes
-----------
.. * Add a short 1-2 sentence description of the ABI change that was announced in
the previous releases and made in this release. Use fixed width quotes for
``rte_function_names`` or ``rte_struct_names``. Use the past tense.
* The ``rte_port_source_params`` structure has new fields to support PCAP files.
It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
@ -372,8 +305,6 @@ ABI Changes
Shared Library Versions
-----------------------
.. Update any library version updated in this release and prepend with a ``+`` sign.
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -412,16 +343,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested with this
release.
The format is:
#. Platform name.
- Platform details.
- Platform details.
#. SuperMicro 1U
- BIOS: 1.0c
@ -472,15 +393,6 @@ Tested Platforms
Tested NICs
-----------
.. This section should contain a list of NICs that were tested with this release.
The format is:
#. NIC name.
- NIC details.
- NIC details.
#. Intel(R) Ethernet Controller X540-AT2
- Firmware version: 0x80000389
@ -539,8 +451,6 @@ Tested NICs
Tested OSes
-----------
.. This section should contain a list of OSes that were tested with this release.
- CentOS 7.0
- Fedora 23
- Fedora 24

124
doc/guides/rel_notes/release_16_11.rst
View File

@ -4,42 +4,9 @@
DPDK Release 16.11
==================
.. **Read this first.**
The text below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
firefox build/doc/html/guides/rel_notes/release_16_11.html
New Features
------------
.. This section should contain new features added in this release. Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense. The description
should be enough to allow someone scanning the release notes to understand
the new feature.
If the feature adds a lot of sub-features you can use a bullet list like this.
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
This section is a comment. Make sure to start the actual text at the margin.
* **Added software parser for packet type.**
* Added a new function ``rte_pktmbuf_read()`` to read the packet data from an
@ -159,20 +126,6 @@ New Features
The config option ``RTE_MACHINE`` can be used to pass code names to the compiler via the ``-march`` flag.
Resolved Issues
---------------
.. This section should contain bug fixes added to the relevant sections. Sample format:
* **code/section Fixed issue in the past tense with a full stop.**
Add a short 1-2 sentence description of the resolved issue in the past tense.
The title should contain the code/lib section like a commit message.
Add the entries in alphabetic order in the relevant sections below.
This section is a comment. Make sure to start the actual text at the margin.
Drivers
~~~~~~~
@ -183,19 +136,9 @@ Drivers
* **enic: Fixed high driver overhead when servicing Rx queues beyond the first.**
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue in the present
tense. Add information on any known workarounds.
This section is a comment. Make sure to start the actual text at the margin.
* **L3fwd-power app does not work properly when Rx vector is enabled.**
The L3fwd-power app doesn't work properly with some drivers in vector mode
@ -223,13 +166,6 @@ Known Issues
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change. Use fixed width
quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. Make sure to start the actual text at the margin.
* The driver naming convention has been changed to make them more
consistent. It especially impacts ``--vdev`` arguments. For example
``eth_pcap`` becomes ``net_pcap`` and ``cryptodev_aesni_mb_pmd`` becomes
@ -273,32 +209,9 @@ API Changes
and ``rte_eal_vdrv_unregister``.
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* Add a short 1-2 sentence description of the ABI change that was announced in
the previous releases and made in this release. Use fixed width quotes for
``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. Make sure to start the actual text at the margin.
Shared Library Versions
-----------------------
.. Update any library version updated in this release and prepend with a ``+``
sign, like this:
libethdev.so.4
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -337,17 +250,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested with this release.
The format is:
#. Platform name.
* Platform details.
* Platform details.
This section is a comment. Make sure to start the actual text at the margin.
#. SuperMicro 1U
- BIOS: 1.0c
@ -412,17 +314,6 @@ Tested Platforms
Tested NICs
-----------
.. This section should contain a list of NICs that were tested with this release.
The format is:
#. NIC name.
* NIC details.
* NIC details.
This section is a comment. Make sure to start the actual text at the margin.
#. Intel(R) Ethernet Controller X540-AT2
- Firmware version: 0x80000389
@ -572,21 +463,6 @@ Tested NICs
Tested OSes
-----------
.. This section should contain a list of OSes that were tested with this release.
The format is as follows, in alphabetical order:
* CentOS 7.0
* Fedora 23
* Fedora 24
* FreeBSD 10.3
* Red Hat Enterprise Linux 7.2
* SUSE Enterprise Linux 12
* Ubuntu 15.10
* Ubuntu 16.04 LTS
* Wind River Linux 8
This section is a comment. Make sure to start the actual text at the margin.
* CentOS 7.2
* Fedora 23
* Fedora 24

97
doc/guides/rel_notes/release_17_02.rst
View File

@ -4,43 +4,9 @@
DPDK Release 17.02
==================
.. **Read this first.**
The text below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
firefox build/doc/html/guides/rel_notes/release_17_02.html
New Features
------------
.. This section should contain new features added in this release. Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense. The description
should be enough to allow someone scanning the release notes to understand
the new feature.
If the feature adds a lot of sub-features you can use a bullet list like this.
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added support for representing buses in EAL**
The ``rte_bus`` structure was introduced into the EAL. This allows for
@ -256,18 +222,6 @@ New Features
Resolved Issues
---------------
.. This section should contain bug fixes added to the relevant sections. Sample format:
* **code/section Fixed issue in the past tense with a full stop.**
Add a short 1-2 sentence description of the resolved issue in the past tense.
The title should contain the code/lib section like a commit message.
Add the entries in alphabetic order in the relevant sections below.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
Drivers
~~~~~~~
@ -286,19 +240,9 @@ Examples
PCI data resulting in a segmentation fault.
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change. Use fixed width
quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Moved five APIs for VF management from the ethdev to the ixgbe PMD.**
The following five APIs for VF management from the PF have been removed from
@ -321,35 +265,9 @@ API Changes
The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* Add a short 1-2 sentence description of the ABI change that was announced in
the previous releases and made in this release. Use fixed width quotes for
``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
Shared Library Versions
-----------------------
.. Update any library version updated in this release and prepend with a ``+``
sign, like this:
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
This section is a comment. do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -388,21 +306,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
This release has been tested with the below list of CPU/device/firmware/OS.
Each section describes a different set of combinations.

121
doc/guides/rel_notes/release_17_05.rst
View File

@ -4,46 +4,9 @@
DPDK Release 17.05
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_17_05.html
New Features
------------
.. This section should contain new features added in this release. Sample
format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense. The description
should be enough to allow someone scanning the release notes to
understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list like
this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Reorganized mbuf structure.**
The mbuf structure has been reorganized as follows:
@ -328,23 +291,6 @@ New Features
Resolved Issues
---------------
.. This section should contain bug fixes added to the relevant
sections. Sample format:
* **code/section Fixed issue in the past tense with a full stop.**
Add a short 1-2 sentence description of the resolved issue in the past
tense.
The title should contain the code/lib section like a commit message.
Add the entries in alphabetic order in the relevant sections below.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **l2fwd-keepalive: Fixed unclean shutdowns.**
Added clean shutdown to l2fwd-keepalive so that it can free up
@ -354,17 +300,6 @@ Resolved Issues
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue in the present
tense. Add information on any known workarounds.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **LSC interrupt doesn't work for virtio-user + vhost-kernel.**
LSC interrupt cannot be detected when setting the backend, tap device,
@ -374,16 +309,6 @@ Known Issues
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change. Use fixed width
quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
while keeping ABI compatibility.
@ -466,16 +391,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* Add a short 1-2 sentence description of the ABI change that was announced
in the previous releases and made in this release. Use fixed width quotes
for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Reorganized the mbuf structure.**
The order and size of the fields in the ``mbuf`` structure changed,
@ -488,15 +403,6 @@ ABI Changes
Removed Items
-------------
.. This section should contain removed items in this release. Sample format:
* Add a short 1-2 sentence description of the removed item in the past
tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* KNI vhost support has been removed.
* The dpdk_qat sample application has been removed.
@ -504,17 +410,6 @@ Removed Items
Shared Library Versions
-----------------------
.. Update any library version updated in this release and prepend with a ``+``
sign, like this:
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
This section is a comment. do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -557,22 +452,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested with this
release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Intel(R) NICs combinations
* CPU

95
doc/guides/rel_notes/release_17_08.rst
View File

@ -4,46 +4,9 @@
DPDK Release 17.08
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_17_08.html
New Features
------------
.. This section should contain new features added in this release. Sample
format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense. The description
should be enough to allow someone scanning the release notes to
understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list like
this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Increase minimum x86 ISA version to SSE4.2.**
Starting with version 17.08, DPDK requires SSE4.2 to run on x86.
@ -218,33 +181,12 @@ New Features
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue in the present
tense. Add information on any known workarounds.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Starting with version 17.08, libnuma is required to build DPDK.**
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change. Use fixed width
quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Modified the _rte_eth_dev_callback_process function in the ethdev library.**
The function ``_rte_eth_dev_callback_process()`` has been modified. The
@ -307,16 +249,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* Add a short 1-2 sentence description of the ABI change that was announced
in the previous releases and made in this release. Use fixed width quotes
for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Changed type of ``domain`` field in ``rte_pci_addr`` to ``uint32_t``
to follow the PCI standard.
@ -359,17 +291,6 @@ ABI Changes
Shared Library Versions
-----------------------
.. Update any library version updated in this release and prepend with a ``+``
sign, like this:
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
This section is a comment. do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -413,22 +334,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested with this
release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Mellanox(R) NICs combinations
* Platform details:

110
doc/guides/rel_notes/release_17_11.rst
View File

@ -4,46 +4,9 @@
DPDK Release 17.11
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_17_11.html
New Features
------------
.. This section should contain new features added in this release. Sample
format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense. The description
should be enough to allow someone scanning the release notes to
understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list like
this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Extended port_id range from uint8_t to uint16_t.**
Increased the ``port_id`` range from 8 bits to 16 bits in order to support
@ -293,23 +256,6 @@ New Features
Resolved Issues
---------------
.. This section should contain bug fixes added to the relevant
sections. Sample format:
* **code/section Fixed issue in the past tense with a full stop.**
Add a short 1-2 sentence description of the resolved issue in the past
tense.
The title should contain the code/lib section like a commit message.
Add the entries in alphabetic order in the relevant sections below.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Service core fails to call service callback due to atomic lock**
In a specific configuration of multi-thread unsafe services and service
@ -322,16 +268,6 @@ Resolved Issues
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change. Use fixed width
quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Ethdev device name length increased.**
The size of internal device name has been increased to 64 characters
@ -491,16 +427,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* Add a short 1-2 sentence description of the ABI change that was announced
in the previous releases and made in this release. Use fixed width quotes
for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Extended port_id range.**
The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
@ -520,15 +446,6 @@ ABI Changes
Removed Items
-------------
.. This section should contain removed items in this release. Sample format:
* Add a short 1-2 sentence description of the removed item in the past
tense.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Xen dom0 in EAL has been removed, as well as the xenvirt PMD and vhost_xen.
* The crypto performance unit tests have been removed,
@ -538,17 +455,6 @@ Removed Items
Shared Library Versions
-----------------------
.. Update any library version updated in this release and prepend with a ``+``
sign, like this:
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
This section is a comment. do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -605,22 +511,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested with this
release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Intel(R) NICs combinations
* CPU

65
doc/guides/rel_notes/release_18_02.rst
View File

@ -4,46 +4,9 @@
DPDK Release 18.02
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_18_02.html
New Features
------------
.. This section should contain new features added in this release. Sample
format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense. The description
should be enough to allow someone scanning the release notes to
understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list like
this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added function to allow releasing internal EAL resources on exit.**
During ``rte_eal_init()`` EAL allocates memory from hugepages to enable its
@ -260,17 +223,6 @@ New Features
Shared Library Versions
-----------------------
.. Update any library version updated in this release and prepend with a ``+``
sign, like this:
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
This section is a comment. do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -326,26 +278,9 @@ The libraries prepended with a plus sign were incremented in this version.
librte_vhost.so.3
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested with this
release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Intel(R) NICs combinations
* CPU

95
doc/guides/rel_notes/release_18_05.rst
View File

@ -4,46 +4,9 @@
DPDK Release 18.05
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_18_05.html
New Features
------------
.. This section should contain new features added in this release. Sample
format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense. The description
should be enough to allow someone scanning the release notes to
understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list like
this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Reworked memory subsystem.**
Memory subsystem has been reworked to support new functionality.
@ -343,16 +306,6 @@ New Features
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change. Use fixed width
quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* service cores: No longer marked as experimental.
The service cores functions are no longer marked as experimental, and have
@ -507,16 +460,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* Add a short 1-2 sentence description of the ABI change that was announced
in the previous releases and made in this release. Use fixed width quotes
for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* ring: The alignment constraints on the ring structure has been relaxed
to one cache line instead of two, and an empty cache line padding is
added between the producer and consumer structures. The size of the
@ -572,17 +515,6 @@ ABI Changes
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue in the present
tense. Add information on any known workarounds.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Secondary process launch is not reliable.**
Recent memory hotplug patches have made multiprocess startup less reliable
@ -647,17 +579,6 @@ Known Issues
Shared Library Versions
-----------------------
.. Update any library version updated in this release and prepend with a ``+``
sign, like this:
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
This section is a comment. Do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -721,22 +642,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested with this
release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Intel(R) NICs combinations
* CPU

73
doc/guides/rel_notes/release_18_08.rst
View File

@ -4,46 +4,9 @@
DPDK Release 18.08
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_18_08.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added support for Hyper-V netvsc PMD.**
The new ``netvsc`` poll mode driver provides native support for
@ -121,16 +84,6 @@ New Features
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change.
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* The path to the runtime config file has changed. The new path is determined
as follows:
@ -221,16 +174,6 @@ API Changes
Shared Library Versions
-----------------------
.. Update any library version updated in this release
and prepend with a ``+`` sign, like this:
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
This section is a comment. Do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -295,22 +238,6 @@ The libraries prepended with a plus sign were incremented in this version.
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Intel(R) NICs combinations
* CPU

105
doc/guides/rel_notes/release_18_11.rst
View File

@ -4,56 +4,9 @@
DPDK Release 18.11
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_18_11.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added support for using externally allocated memory in DPDK.**
DPDK has added support for creating new ``rte_malloc`` heaps referencing
@ -356,16 +309,6 @@ New Features
API Changes
-----------
.. This section should contain API changes. Sample format:
* Add a short 1-2 sentence description of the API change.
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* eal: ``rte_memseg_list`` structure now has an additional flag indicating
whether the memseg list is externally allocated. This will have implications
for any users of memseg-walk-related functions, as they will now have to skip
@ -448,17 +391,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* Add a short 1-2 sentence description of the ABI change
that was announced in the previous releases and made in this release.
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* eal: added ``legacy_mem`` and ``single_file_segments`` values to
``rte_config`` structure on account of improving DPDK usability when
using either ``--legacy-mem`` or ``--single-file-segments`` flags.
@ -489,16 +421,6 @@ ABI Changes
Shared Library Versions
-----------------------
.. Update any library version updated in this release
and prepend with a ``+`` sign, like this:
librte_acl.so.2
+ librte_cfgfile.so.2
librte_cmdline.so.2
This section is a comment. Do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -564,17 +486,6 @@ The libraries prepended with a plus sign were incremented in this version.
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue
in the present tense. Add information on any known workarounds.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5
bifurcated driver the Linux netvsc device must be brought up before the
netvsc device is unbound and passed to the DPDK.
@ -598,22 +509,6 @@ Known Issues
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Intel(R) NICs combinations
* CPU

108
doc/guides/rel_notes/release_19_02.rst
View File

@ -4,56 +4,9 @@
DPDK Release 19.02
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_19_02.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added support for freeing hugepages exactly as originally allocated.**
Some applications using memory event callbacks (especially for managing
@ -197,18 +150,6 @@ New Features
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* eal: Function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64``
function has been added in ``rte_common.h`` that follows the convention set
@ -250,18 +191,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* mbuf: The format of the sched field of ``rte_mbuf`` has been changed
to include the following fields: ``queue ID``, ``traffic class``, ``color``.
@ -281,16 +210,6 @@ ABI Changes
Shared Library Versions
-----------------------
.. Update any library version updated in this release
and prepend with a ``+`` sign, like this:
libfoo.so.1
+ libupdated.so.2
libbar.so.1
This section is a comment. Do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -356,17 +275,6 @@ The libraries prepended with a plus sign were incremented in this version.
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue
in the present tense. Add information on any known workarounds.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* ``AVX-512`` support has been disabled for ``GCC`` builds when ``binutils 2.30``
is detected [1] because of a crash [2]. This can affect ``native`` machine type
build targets on the platforms that support ``AVX512F`` like ``Intel Skylake``
@ -386,22 +294,6 @@ Known Issues
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Intel(R) NICs combinations
* CPU

108
doc/guides/rel_notes/release_19_05.rst
View File

@ -4,56 +4,9 @@
DPDK Release 19.05
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_19_05.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added new armv8 machine targets.**
Added new armv8 machine targets:
@ -258,18 +211,6 @@ New Features
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* eal: the type of the ``attr_value`` parameter of the function
``rte_service_attr_get()`` has been changed
from ``uint32_t *`` to ``uint64_t *``.
@ -295,18 +236,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* ethdev: Additional fields in rte_eth_dev_info.
The ``rte_eth_dev_info`` structure has had two extra fields
@ -328,16 +257,6 @@ ABI Changes
Shared Library Versions
-----------------------
.. Update any library version updated in this release
and prepend with a ``+`` sign, like this:
libfoo.so.1
+ libupdated.so.2
libbar.so.1
This section is a comment. Do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -406,17 +325,6 @@ The libraries prepended with a plus sign were incremented in this version.
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue
in the present tense. Add information on any known workarounds.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **On x86 platforms, AVX512 support is disabled with binutils 2.31.**
Due to a defect in binutils 2.31 AVX512 support is disabled.
@ -433,22 +341,6 @@ Known Issues
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Intel(R) NICs combinations
* CPU

117
doc/guides/rel_notes/release_19_08.rst
View File

@ -6,56 +6,9 @@
DPDK Release 19.08
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_19_08.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **EAL will now pick IOVA as VA mode as the default in most cases.**
Previously, the preferred default IOVA mode was selected to be IOVA as PA. The
@ -243,15 +196,6 @@ New Features
Removed Items
-------------
.. This section should contain removed items in this release. Sample format:
* Add a short 1-2 sentence description of the removed item
in the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Removed KNI ethtool, ``CONFIG_RTE_KNI_KMOD_ETHTOOL``, support.
* build: armv8 crypto extension is disabled.
@ -260,18 +204,6 @@ Removed Items
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* The ``rte_mem_config`` structure has been made private. New accessor
``rte_mcfg_*`` functions were introduced to provide replacement for direct
access to the shared mem config.
@ -321,18 +253,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* eventdev: Event based Rx adapter callback
The mbuf pointer array in the event eth Rx adapter callback
@ -365,16 +285,6 @@ ABI Changes
Shared Library Versions
-----------------------
.. Update any library version updated in this release
and prepend with a ``+`` sign, like this:
libfoo.so.1
+ libupdated.so.2
libbar.so.1
This section is a comment. Do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -443,17 +353,6 @@ The libraries prepended with a plus sign were incremented in this version.
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue
in the present tense. Add information on any known workarounds.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Unsuitable IOVA mode may be picked as the default.**
Not all kernel drivers and not all devices support all IOVA modes. EAL will
@ -467,22 +366,6 @@ Known Issues
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel(R) platforms with Intel(R) NICs combinations
* CPU

121
doc/guides/rel_notes/release_19_11.rst
View File

@ -6,56 +6,9 @@
DPDK Release 19.11
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_19_11.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added support for --base-virtaddr EAL option to FreeBSD.**
The FreeBSD version of DPDK now also supports setting base virtual address
@ -346,15 +299,6 @@ New Features
Removed Items
-------------
.. This section should contain removed items in this release. Sample format:
* Add a short 1-2 sentence description of the removed item
in the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Removed library-level ABI versions. These have been replaced with a single
project-level ABI version for non-experimental libraries and an ABI version of
``0`` for experimental libraries. Review the :doc:`../contributing/abi_policy`
@ -390,18 +334,6 @@ Removed Items
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* eal: made the ``lcore_config`` struct and global symbol private.
* eal: removed the ``rte_cpu_check_supported`` function, replaced by
@ -486,18 +418,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* policy: Please note the revisions to the :doc:`../contributing/abi_policy`
introducing major ABI versions, with DPDK 19.11 becoming the first major
version ``v20``. ABI changes to add new features continue to be permitted in
@ -530,16 +450,6 @@ ABI Changes
Shared Library Versions
-----------------------
.. Update any library version updated in this release
and prepend with a ``+`` sign, like this:
libfoo.so.1
+ libupdated.so.2
libbar.so.1
This section is a comment. Do not overwrite or remove it.
=========================================================
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
@ -607,40 +517,9 @@ The libraries prepended with a plus sign were incremented in this version.
librte_vhost.so.4
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue
in the present tense. Add information on any known workarounds.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel\ |reg| platforms with Intel\ |reg| NICs combinations
* CPU

96
doc/guides/rel_notes/release_20_02.rst
View File

@ -6,56 +6,9 @@
DPDK Release 20.02
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_20_02.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added Wait Until Equal API.**
A new API has been added to wait for a memory location to be updated with a
@ -255,15 +208,6 @@ New Features
Removed Items
-------------
.. This section should contain removed items in this release. Sample format:
* Add a short 1-2 sentence description of the removed item
in the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Disabled building all the Linux kernel modules by default.**
In order to remove the build time dependency on the Linux kernel,
@ -283,18 +227,6 @@ Removed Items
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* No change in this release.
@ -303,18 +235,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
* The soname for each stable ABI version should be just the ABI version major
@ -331,22 +251,6 @@ ABI Changes
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel\ |reg| platforms with Intel\ |reg| NICs combinations
* CPU

87
doc/guides/rel_notes/release_20_05.rst
View File

@ -6,56 +6,9 @@
DPDK Release 20.05
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_20_05.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added Trace Library and Tracepoints.**
Added a native implementation of the "common trace format" (CTF) based trace
@ -351,18 +304,6 @@ New Features
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* mempool: The API of ``rte_mempool_populate_iova()`` and
``rte_mempool_populate_virt()`` changed to return 0 instead of ``-EINVAL``
when there is not enough room to store one object.
@ -371,40 +312,12 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* No ABI change that would break compatibility with DPDK 20.02 and 19.11.
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel\ |reg| platforms with Broadcom\ |reg| NICs combinations
* CPU:

107
doc/guides/rel_notes/release_20_08.rst
View File

@ -6,56 +6,9 @@
DPDK Release 20.08
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_20_08.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **Added non-EAL threads registration API.**
Added a new API to register non-EAL threads as lcores. This can be used by
@ -276,33 +229,12 @@ New Features
Removed Items
-------------
.. This section should contain removed items in this release. Sample format:
* Add a short 1-2 sentence description of the removed item
in the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
* vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
@ -312,35 +244,12 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* No ABI change that would break compatibility with 19.11.
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue
in the present tense. Add information on any known workarounds.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* **mlx5 PMD does not work on Power 9 with OFED 5.1-0.6.6.0.**
Consider using the newer OFED releases, the previous
@ -350,22 +259,6 @@ Known Issues
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=========================================================
* Intel\ |reg| platforms with Intel\ |reg| NICs combinations
* CPU

95
doc/guides/rel_notes/release_20_11.rst
View File

@ -6,55 +6,9 @@
DPDK Release 20.11
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_20_11.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* **Added write combining store APIs.**
Added ``rte_write32_wc`` and ``rte_write32_wc_relaxed`` APIs
@ -432,15 +386,6 @@ New Features
Removed Items
-------------
.. This section should contain removed items in this release. Sample format:
* Add a short 1-2 sentence description of the removed item
in the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* build: Support for the Make build system has been removed from DPDK.
Meson is now the primary build system.
Sample applications can still be built with Make standalone, using pkg-config.
@ -462,18 +407,6 @@ Removed Items
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` have been removed.
The information provided by these macros is now available through standard
compiler macros.
@ -666,18 +599,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* eal: Removed the unimplemented function ``rte_dump_registers()``.
* ``ethdev`` changes
@ -732,22 +653,6 @@ ABI Changes
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* Intel\ |reg| platforms with Intel\ |reg| NICs combinations
* CPU

94
doc/guides/rel_notes/release_21_02.rst
View File

@ -6,20 +6,6 @@
DPDK Release 21.02
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_21_02.html
.. note::
A **dependency** has been added for building DPDK on Linux or FreeBSD:
@ -34,37 +20,6 @@ DPDK Release 21.02
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* **Added new ethdev API for PMD power management.**
Added ``rte_eth_get_monitor_addr()``, to be used in conjunction with
@ -209,15 +164,6 @@ New Features
Removed Items
-------------
.. This section should contain removed items in this release. Sample format:
* Add a short 1-2 sentence description of the removed item
in the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* The internal header files ``rte_ethdev_driver.h``, ``rte_ethdev_vdev.h`` and
``rte_ethdev_pci.h`` are no longer installed as part of the DPDK
``ninja install`` action and are renamed to ``ethdev_driver.h``,
@ -243,18 +189,6 @@ Removed Items
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* config: Removed the old macros, included in ``rte_config.h``,
to indicate which DPDK libraries and drivers are built.
The new macros are generated by meson in a standardized format:
@ -269,18 +203,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* No ABI change that would break compatibility with 20.11.
* The experimental function ``rte_telemetry_init`` has been removed from the
@ -292,22 +214,6 @@ ABI Changes
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* Intel\ |reg| platforms with Intel\ |reg| NICs combinations
* CPU

95
doc/guides/rel_notes/release_21_05.rst
View File

@ -6,55 +6,9 @@
DPDK Release 21.05
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_21_05.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs (ordered alphabetically by vendor name)
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* **Added support for GCC 11 and clang 12.**
Added support for building with GCC 11.1.1 and clang 12.0.0.
@ -321,15 +275,6 @@ New Features
Removed Items
-------------
.. This section should contain removed items in this release. Sample format:
* Add a short 1-2 sentence description of the removed item
in the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* Removed support for Intel DLB V1 hardware. This is not a broad market device,
and existing customers already obtain the source code directly from Intel.
@ -337,18 +282,6 @@ Removed Items
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
and confusion with the transport layer security term.
@ -394,18 +327,6 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* No ABI change that would break compatibility with 20.11.
* The experimental function ``rte_telemetry_legacy_register`` has been
@ -417,22 +338,6 @@ ABI Changes
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* Intel\ |reg| platforms with Intel\ |reg| NICs combinations
* CPU

97
doc/guides/rel_notes/release_21_08.rst
View File

@ -6,55 +6,9 @@
DPDK Release 21.08
==================
.. **Read this first.**
The text in the sections below explains how to update the release notes.
Use proper spelling, capitalization and punctuation in all sections.
Variable and config names should be quoted as fixed width text:
``LIKE_THIS``.
Build the docs and view the output file to ensure the changes are correct::
make doc-guides-html
xdg-open build/doc/html/guides/rel_notes/release_21_08.html
New Features
------------
.. This section should contain new features added in this release.
Sample format:
* **Add a title in the past tense with a full stop.**
Add a short 1-2 sentence description in the past tense.
The description should be enough to allow someone scanning
the release notes to understand the new feature.
If the feature adds a lot of sub-features you can use a bullet list
like this:
* Added feature foo to do something.
* Enhanced feature bar to do something else.
Refer to the previous release notes for examples.
Suggested order in release notes items:
* Core libs (EAL, mempool, ring, mbuf, buses)
* Device abstraction libs and PMDs (ordered alphabetically by vendor name)
- ethdev (lib, PMDs)
- cryptodev (lib, PMDs)
- eventdev (lib, PMDs)
- etc
* Other libs
* Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* **Added auxiliary bus support.**
An auxiliary bus provides a way to split a function into child-devices
@ -179,18 +133,6 @@ New Features
API Changes
-----------
.. This section should contain API changes. Sample format:
* sample: Add a short 1-2 sentence description of the API change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
truncation.
@ -209,35 +151,12 @@ API Changes
ABI Changes
-----------
.. This section should contain ABI changes. Sample format:
* sample: Add a short 1-2 sentence description of the ABI change
which was announced in the previous releases and made in this release.
Start with a scope label like "ethdev:".
Use fixed width quotes for ``function_names`` or ``struct_names``.
Use the past tense.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* No ABI change that would break compatibility with 20.11.
Known Issues
------------
.. This section should contain new known issues in this release. Sample format:
* **Add title in present tense with full stop.**
Add a short 1-2 sentence description of the known issue
in the present tense. Add information on any known workarounds.
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* **Last mbuf segment not implicitly reset.**
It is expected that free mbufs have their field ``nb_seg`` set to 1,
@ -258,22 +177,6 @@ Known Issues
Tested Platforms
----------------
.. This section should contain a list of platforms that were tested
with this release.
The format is:
* <vendor> platform with <vendor> <type of devices> combinations
* List of CPU
* List of OS
* List of devices
* Other relevant details...
This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin.
=======================================================
* Intel\ |reg| platforms with Intel\ |reg| NICs combinations
* CPU

1
doc/guides/rel_notes/release_2_0.rst
View File

@ -4,7 +4,6 @@
DPDK Release 2.0
================
New Features
------------

2
doc/guides/rel_notes/release_2_1.rst
View File

@ -4,7 +4,6 @@
DPDK Release 2.1
================
New Features
------------
@ -387,7 +386,6 @@ New Features
64M.
Resolved Issues
---------------