doc: announce changes to eventdev public data structures
Checks
Commit Message
From: "McDaniel, Timothy" <timothy.mcdaniel@intel.com>
Signed-off-by: McDaniel, Timothy <timothy.mcdaniel@intel.com>
---
doc/guides/rel_notes/deprecation.rst | 11 +++++++++++
1 file changed, 11 insertions(+)
Comments
On Sat, Aug 1, 2020 at 1:04 AM McDaniel, Timothy
<timothy.mcdaniel@intel.com> wrote:
>
> From: "McDaniel, Timothy" <timothy.mcdaniel@intel.com>
The patch should have some description and
Please change the subject to: "doc: eventdev ABI change to support DLB PMD"
>
> Signed-off-by: McDaniel, Timothy <timothy.mcdaniel@intel.com>
We don't use "," in the Signed-off-by.
Please change to ``Signed-off-by: McDaniel Timothy
<timothy.mcdaniel@intel.com>``
> ---
> doc/guides/rel_notes/deprecation.rst | 11 +++++++++++
> 1 file changed, 11 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 99c9806..b9682a7 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -148,3 +148,14 @@ Deprecation Notices
> Python 2 support will be completely removed in 20.11.
> In 20.08, explicit deprecation warnings will be displayed when running
> scripts with Python 2.
> +
> +* eventdev: ABI change to support DLB PMD and future extensions
> + The following structures and will be modified to support to DLB PMD and future
> + extension in the eventdev library.
> + - ``rte_event_dev_info``
> + - ``rte_event_dev_config``
> + - ``rte_event_port_conf``
> + Patches containing justification, documentation, and proposed modifications
> + can be found at:
> + - https://patches.dpdk.org/patch/71457/
> + - https://patches.dpdk.org/patch/71456/
The HTML rendering of the above text is not proper.
Please run "make doc-guides-html" to check generated HTML output.
You could use the below text as an example for sphinx syntax.
* eventdev: ABI change to support DLB PMD and future extensions:
``rte_event_dev_info``, ``rte_event_dev_config``, ``rte_event_port_conf`` will
be modified to support to DLB PMD and future extension in the
eventdev library.
Patches containing justification, documentation, and proposed modifications
can be found at:
- https://patches.dpdk.org/patch/71457/
- https://patches.dpdk.org/patch/71456/
With the above changes:
Acked-by: Jerin Jacob <jerinj@marvell.com>
> --
> 1.7.10
>
@@ -148,3 +148,14 @@ Deprecation Notices
Python 2 support will be completely removed in 20.11.
In 20.08, explicit deprecation warnings will be displayed when running
scripts with Python 2.
+
+* eventdev: ABI change to support DLB PMD and future extensions
+ The following structures and will be modified to support to DLB PMD and future
+ extension in the eventdev library.
+ - ``rte_event_dev_info``
+ - ``rte_event_dev_config``
+ - ``rte_event_port_conf``
+ Patches containing justification, documentation, and proposed modifications
+ can be found at:
+ - https://patches.dpdk.org/patch/71457/
+ - https://patches.dpdk.org/patch/71456/