[dpdk-dev,v1] doc: update deprecation notice of rte_devargs

Message ID 20180207092610.6593-1-gaetan.rivet@6wind.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

Gaëtan Rivet Feb. 7, 2018, 9:26 a.m. UTC
  The declaration and identification of devices will change in v18.05.

Remove the precedent deprecation notice

Add new one reflecting the planned changes more accurately,
updated for v18.05.

Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)
  

Comments

Shreyansh Jain Feb. 7, 2018, 12:41 p.m. UTC | #1
On Wednesday 07 February 2018 02:56 PM, Gaetan Rivet wrote:
> The declaration and identification of devices will change in v18.05.
> 
> Remove the precedent deprecation notice
> 
> Add new one reflecting the planned changes more accurately,
> updated for v18.05.
> 
> Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
> ---

Acked-By: Shreyansh Jain <shreyansh.jain@nxp.com>
  
Ferruh Yigit Feb. 13, 2018, 11:26 a.m. UTC | #2
On 2/7/2018 12:41 PM, Shreyansh Jain wrote:
> On Wednesday 07 February 2018 02:56 PM, Gaetan Rivet wrote:
>> The declaration and identification of devices will change in v18.05.
>>
>> Remove the precedent deprecation notice
>>
>> Add new one reflecting the planned changes more accurately,
>> updated for v18.05.
>>
>> Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
>> ---
> 
> Acked-By: Shreyansh Jain <shreyansh.jain@nxp.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Thomas Monjalon Feb. 13, 2018, 11:51 p.m. UTC | #3
13/02/2018 12:26, Ferruh Yigit:
> On 2/7/2018 12:41 PM, Shreyansh Jain wrote:
> > On Wednesday 07 February 2018 02:56 PM, Gaetan Rivet wrote:
> >> The declaration and identification of devices will change in v18.05.
> >>
> >> Remove the precedent deprecation notice
> >>
> >> Add new one reflecting the planned changes more accurately,
> >> updated for v18.05.
> >>
> >> Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
> > 
> > Acked-By: Shreyansh Jain <shreyansh.jain@nxp.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>
  
Thomas Monjalon Feb. 14, 2018, 10:54 a.m. UTC | #4
14/02/2018 00:51, Thomas Monjalon:
> 13/02/2018 12:26, Ferruh Yigit:
> > On 2/7/2018 12:41 PM, Shreyansh Jain wrote:
> > > On Wednesday 07 February 2018 02:56 PM, Gaetan Rivet wrote:
> > >> The declaration and identification of devices will change in v18.05.
> > >>
> > >> Remove the precedent deprecation notice
> > >>
> > >> Add new one reflecting the planned changes more accurately,
> > >> updated for v18.05.
> > >>
> > >> Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
> > > 
> > > Acked-By: Shreyansh Jain <shreyansh.jain@nxp.com>
> > 
> > Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index d59ad5988..07312f59a 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -8,18 +8,23 @@  API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
-* eal: several API and ABI changes are planned for ``rte_devargs`` in v18.02.
-  The format of device command line parameters will change. The bus will need
-  to be explicitly stated in the device declaration. The enum ``rte_devtype``
-  was used to identify a bus and will disappear.
-  The structure ``rte_devargs`` will change.
-  The ``rte_devargs_list`` will be made private.
-  The following functions are deprecated starting from 17.08 and will either be
-  modified or removed in 18.02:
+* eal: both declaring and identifying devices will be streamlined in v18.05.
+  New functions will appear to query a specific port from buses, classes of
+  device and device drivers. Device declaration will be made coherent with the
+  new scheme of device identification.
+  As such, ``rte_devargs`` device representation will change.
 
-  - ``rte_eal_devargs_add``
-  - ``rte_eal_devargs_type_count``
-  - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
+  - removal of ``name`` and ``args`` fields.
+  - The enum ``rte_devtype`` was used to identify a bus and will disappear.
+  - The ``rte_devargs_list`` will be made private.
+  - Functions previously deprecated will change or disappear:
+
+    + ``rte_eal_devargs_add``
+    + ``rte_eal_devargs_type_count``
+    + ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
+    + ``rte_eal_devargs_parse`` will change its format and use.
+    + all ``rte_devargs`` related functions will be renamed, changing the
+      ``rte_eal_devargs_`` prefix to ``rte_devargs_``.
 
 * pci: Several exposed functions are misnamed.
   The following functions are deprecated starting from v17.11 and are replaced: