[2/2] doc: add deprecation notice for change of rawdev APIs
diff mbox series

Message ID 20200713123105.513960-3-bruce.richardson@intel.com
State Accepted
Delegated to: Thomas Monjalon
Headers show
Series
  • Deprecation notice updates
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed
ci/checkpatch warning coding style issues

Commit Message

Bruce Richardson July 13, 2020, 12:31 p.m. UTC
Add to the documentation for 20.08 a notice about the changes of rawdev
APIs proposed by patchset [1].

[1] http://inbox.dpdk.org/dev/20200709152047.167730-1-bruce.richardson@intel.com/

Cc: Nipun Gupta <nipun.gupta@nxp.com>
Cc: Hemant Agrawal <hemant.agrawal@nxp.com>

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Hemant Agrawal July 13, 2020, 12:48 p.m. UTC | #1
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>

-----Original Message-----
From: Bruce Richardson <bruce.richardson@intel.com> 
Sent: Monday, July 13, 2020 6:01 PM
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>; Nipun Gupta <nipun.gupta@nxp.com>; Hemant Agrawal <hemant.agrawal@nxp.com>
Subject: [PATCH 2/2] doc: add deprecation notice for change of rawdev APIs
Importance: High

Add to the documentation for 20.08 a notice about the changes of rawdev APIs proposed by patchset [1].

[1] https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Finbox.dpdk.org%2Fdev%2F20200709152047.167730-1-bruce.richardson%40intel.com%2F&amp;data=02%7C01%7Chemant.agrawal%40nxp.com%7C0f08b692d7e1471fa69908d82728a944%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637302402871919863&amp;sdata=MfNlKHVOUk%2FRViCJBqSnyJRB%2BnnKpPeViN6OiCb9MJA%3D&amp;reserved=0

Cc: Nipun Gupta <nipun.gupta@nxp.com>
Cc: Hemant Agrawal <hemant.agrawal@nxp.com>

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ead7cbe43..21b00103e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -117,6 +117,13 @@ Deprecation Notices
   break the ABI checks, that is why change is planned for 20.11.
   The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``.
 
+* rawdev: The rawdev APIs which take a device-specific structure as
+  parameter directly, or indirectly via a "private" pointer inside 
+another
+  structure, will be modified to take an additional parameter of the
+  structure size. The affected APIs will include 
+``rte_rawdev_info_get``,
+  ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and
+  ``rte_rawdev_queue_setup``.
+
 * traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
   ABI stable in the v19.11 release. The TM maintainer and other contributors have
   agreed to keep the TM APIs as experimental in expectation of additional spec
--
2.25.1
Konstantin Ananyev July 20, 2020, 11:35 a.m. UTC | #2
> Add to the documentation for 20.08 a notice about the changes of rawdev
> APIs proposed by patchset [1].
> 
> [1] http://inbox.dpdk.org/dev/20200709152047.167730-1-bruce.richardson@intel.com/
> 
> Cc: Nipun Gupta <nipun.gupta@nxp.com>
> Cc: Hemant Agrawal <hemant.agrawal@nxp.com>
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index ead7cbe43..21b00103e 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -117,6 +117,13 @@ Deprecation Notices
>    break the ABI checks, that is why change is planned for 20.11.
>    The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``.
> 
> +* rawdev: The rawdev APIs which take a device-specific structure as
> +  parameter directly, or indirectly via a "private" pointer inside another
> +  structure, will be modified to take an additional parameter of the
> +  structure size. The affected APIs will include ``rte_rawdev_info_get``,
> +  ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and
> +  ``rte_rawdev_queue_setup``.
> +
>  * traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
>    ABI stable in the v19.11 release. The TM maintainer and other contributors have
>    agreed to keep the TM APIs as experimental in expectation of additional spec
> --

Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com

> 2.25.1
Xu, Rosen July 23, 2020, 1:55 a.m. UTC | #3
Hi,

-----Original Message-----
From: dev <dev-bounces@dpdk.org> On Behalf Of Bruce Richardson
Sent: Monday, July 13, 2020 8:31 PM
To: dev@dpdk.org
Cc: Richardson, Bruce <bruce.richardson@intel.com>; Nipun Gupta <nipun.gupta@nxp.com>; Hemant Agrawal <hemant.agrawal@nxp.com>
Subject: [dpdk-dev] [PATCH 2/2] doc: add deprecation notice for change of rawdev APIs

Add to the documentation for 20.08 a notice about the changes of rawdev APIs proposed by patchset [1].

[1] http://inbox.dpdk.org/dev/20200709152047.167730-1-bruce.richardson@intel.com/

Cc: Nipun Gupta <nipun.gupta@nxp.com>
Cc: Hemant Agrawal <hemant.agrawal@nxp.com>

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ead7cbe43..21b00103e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -117,6 +117,13 @@ Deprecation Notices
   break the ABI checks, that is why change is planned for 20.11.
   The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``.
 
+* rawdev: The rawdev APIs which take a device-specific structure as
+  parameter directly, or indirectly via a "private" pointer inside 
+another
+  structure, will be modified to take an additional parameter of the
+  structure size. The affected APIs will include 
+``rte_rawdev_info_get``,
+  ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and
+  ``rte_rawdev_queue_setup``.
+
 * traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
   ABI stable in the v19.11 release. The TM maintainer and other contributors have
   agreed to keep the TM APIs as experimental in expectation of additional spec
--
2.25.1

Acked-by: Rosen Xu <rosen.xu@intel.com>
Hemant Agrawal July 23, 2020, 7:38 a.m. UTC | #4
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>

-----Original Message-----
From: Xu, Rosen <rosen.xu@intel.com> 
Sent: Thursday, July 23, 2020 7:26 AM
To: Richardson, Bruce <bruce.richardson@intel.com>; dev@dpdk.org
Cc: Richardson, Bruce <bruce.richardson@intel.com>; Nipun Gupta <nipun.gupta@nxp.com>; Hemant Agrawal <hemant.agrawal@nxp.com>
Subject: RE: [dpdk-dev] [PATCH 2/2] doc: add deprecation notice for change of rawdev APIs
Importance: High

Hi,

-----Original Message-----
From: dev <dev-bounces@dpdk.org> On Behalf Of Bruce Richardson
Sent: Monday, July 13, 2020 8:31 PM
To: dev@dpdk.org
Cc: Richardson, Bruce <bruce.richardson@intel.com>; Nipun Gupta <nipun.gupta@nxp.com>; Hemant Agrawal <hemant.agrawal@nxp.com>
Subject: [dpdk-dev] [PATCH 2/2] doc: add deprecation notice for change of rawdev APIs

Add to the documentation for 20.08 a notice about the changes of rawdev APIs proposed by patchset [1].

[1] https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Finbox.dpdk.org%2Fdev%2F20200709152047.167730-1-bruce.richardson%40intel.com%2F&amp;data=02%7C01%7Chemant.agrawal%40nxp.com%7Cad3a0b27e46648a250d108d82eab80a3%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637310661421942508&amp;sdata=DdzY9DbZwYzLjQasNhDKxxSSpFgbCc%2Foh9NZR1ksuB8%3D&amp;reserved=0

Cc: Nipun Gupta <nipun.gupta@nxp.com>
Cc: Hemant Agrawal <hemant.agrawal@nxp.com>

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ead7cbe43..21b00103e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -117,6 +117,13 @@ Deprecation Notices
   break the ABI checks, that is why change is planned for 20.11.
   The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``.
 
+* rawdev: The rawdev APIs which take a device-specific structure as
+  parameter directly, or indirectly via a "private" pointer inside 
+another
+  structure, will be modified to take an additional parameter of the
+  structure size. The affected APIs will include 
+``rte_rawdev_info_get``,
+  ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and
+  ``rte_rawdev_queue_setup``.
+
 * traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
   ABI stable in the v19.11 release. The TM maintainer and other contributors have
   agreed to keep the TM APIs as experimental in expectation of additional spec
--
2.25.1

Acked-by: Rosen Xu <rosen.xu@intel.com>

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ead7cbe43..21b00103e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -117,6 +117,13 @@  Deprecation Notices
   break the ABI checks, that is why change is planned for 20.11.
   The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``.
 
+* rawdev: The rawdev APIs which take a device-specific structure as
+  parameter directly, or indirectly via a "private" pointer inside another
+  structure, will be modified to take an additional parameter of the
+  structure size. The affected APIs will include ``rte_rawdev_info_get``,
+  ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and
+  ``rte_rawdev_queue_setup``.
+
 * traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
   ABI stable in the v19.11 release. The TM maintainer and other contributors have
   agreed to keep the TM APIs as experimental in expectation of additional spec