diff mbox

[dpdk-dev,v2,04/15] devargs: deprecate enum rte_devtype based functions

Message ID 20170714211213.34436-5-jblunck@infradead.org (mailing list archive)
State Rejected, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Jan Blunck July 14, 2017, 9:12 p.m. UTC 
  The enum rte_devtype will need to get extended every time we add a bus.
Mark all related functions as deprecated for 17.11.

Signed-off-by: Jan Blunck <jblunck@infradead.org>
---
 doc/guides/rel_notes/deprecation.rst        | 7 +++++++
 lib/librte_eal/common/include/rte_devargs.h | 3 +++
 2 files changed, 10 insertions(+)

Comments

Ferruh Yigit Sept. 4, 2017, 4:06 p.m. UTC | #1 
On 7/14/2017 10:12 PM, Jan Blunck wrote:
> The enum rte_devtype will need to get extended every time we add a bus.
> Mark all related functions as deprecated for 17.11.
> 
> Signed-off-by: Jan Blunck <jblunck@infradead.org>
> ---
>  doc/guides/rel_notes/deprecation.rst        | 7 +++++++
>  lib/librte_eal/common/include/rte_devargs.h | 3 +++
>  2 files changed, 10 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 257dcba32..0c763d522 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -64,3 +64,10 @@ Deprecation Notices
>    be removed in 17.11:
>  
>    - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
> +
> +* devargs: An API/ABI change is planed for 17.11 for ``struct rte_devargs`` to
> +  remove ``enum rte_devtype`` so that starting from 17.08 the following
> +  functions are deprecated:
> +
> +  - ``rte_eal_devargs_add``
> +  - ``rte_eal_devargs_type_count``

This also seems already applied.

> diff --git a/lib/librte_eal/common/include/rte_devargs.h b/lib/librte_eal/common/include/rte_devargs.h
> index 62dd67bff..41db817cc 100644
> --- a/lib/librte_eal/common/include/rte_devargs.h
> +++ b/lib/librte_eal/common/include/rte_devargs.h
> @@ -53,6 +53,7 @@ extern "C" {
>  #include <rte_bus.h>
>  
>  /**
> + * @deprecated

Although these "@deprecated" notes not applied.

>   * Type of generic device
>   */
>  enum rte_devtype {
> @@ -139,6 +140,7 @@ rte_eal_devargs_parse(const char *dev,
>  		      struct rte_devargs *da);
>  
>  /**
> + * @deprecated
>   * Add a device to the user device list
>   *
>   * For PCI devices, the format of arguments string is "PCI_ADDR" or
> @@ -163,6 +165,7 @@ rte_eal_devargs_parse(const char *dev,
>  int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
>  
>  /**
> + * @deprecated
>   * Count the number of user devices of a specified type
>   *
>   * @param devtype
>
diff mbox

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 257dcba32..0c763d522 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -64,3 +64,10 @@  Deprecation Notices
   be removed in 17.11:
 
   - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
+
+* devargs: An API/ABI change is planed for 17.11 for ``struct rte_devargs`` to
+  remove ``enum rte_devtype`` so that starting from 17.08 the following
+  functions are deprecated:
+
+  - ``rte_eal_devargs_add``
+  - ``rte_eal_devargs_type_count``
diff --git a/lib/librte_eal/common/include/rte_devargs.h b/lib/librte_eal/common/include/rte_devargs.h
index 62dd67bff..41db817cc 100644
--- a/lib/librte_eal/common/include/rte_devargs.h
+++ b/lib/librte_eal/common/include/rte_devargs.h
@@ -53,6 +53,7 @@  extern "C" {
 #include <rte_bus.h>
 
 /**
+ * @deprecated
  * Type of generic device
  */
 enum rte_devtype {
@@ -139,6 +140,7 @@  rte_eal_devargs_parse(const char *dev,
 		      struct rte_devargs *da);
 
 /**
+ * @deprecated
  * Add a device to the user device list
  *
  * For PCI devices, the format of arguments string is "PCI_ADDR" or
@@ -163,6 +165,7 @@  rte_eal_devargs_parse(const char *dev,
 int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
 
 /**
+ * @deprecated
  * Count the number of user devices of a specified type
  *
  * @param devtype