version: 20.05-rc0
Start a new release cycle with empty release notes. ABI must now be checked with v20.02 as a reference. Signed-off-by: David Marchand <david.marchand@redhat.com> Acked-by: Thomas Monjalon <thomas@monjalon.net>
This commit is contained in:
parent
d7142fbae1
commit
1f362c7a7b
@ -34,6 +34,10 @@ _doc_packages: &doc_packages
|
|||||||
before_install: ./.ci/${TRAVIS_OS_NAME}-setup.sh
|
before_install: ./.ci/${TRAVIS_OS_NAME}-setup.sh
|
||||||
script: ./.ci/${TRAVIS_OS_NAME}-build.sh
|
script: ./.ci/${TRAVIS_OS_NAME}-build.sh
|
||||||
|
|
||||||
|
env:
|
||||||
|
global:
|
||||||
|
- REF_GIT_TAG=v20.02
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
include:
|
include:
|
||||||
# x86_64 gcc jobs
|
# x86_64 gcc jobs
|
||||||
|
@ -1 +1 @@
|
|||||||
20.0.1
|
20.0.2
|
||||||
|
@ -8,6 +8,7 @@ Release Notes
|
|||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
:numbered:
|
:numbered:
|
||||||
|
|
||||||
|
release_20_05
|
||||||
release_20_02
|
release_20_02
|
||||||
release_19_11
|
release_19_11
|
||||||
release_19_08
|
release_19_08
|
||||||
|
139
doc/guides/rel_notes/release_20_05.rst
Normal file
139
doc/guides/rel_notes/release_20_05.rst
Normal file
@ -0,0 +1,139 @@
|
|||||||
|
.. SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
Copyright 2020 The DPDK contributors
|
||||||
|
|
||||||
|
.. include:: <isonum.txt>
|
||||||
|
|
||||||
|
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.
|
||||||
|
=========================================================
|
||||||
|
|
||||||
|
|
||||||
|
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.
|
||||||
|
=========================================================
|
||||||
|
|
||||||
|
|
||||||
|
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.
|
||||||
|
=========================================================
|
||||||
|
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
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.
|
||||||
|
=========================================================
|
Loading…
Reference in New Issue
Block a user