Skip to contentSkip to conversation

doc: update deprecation notice of rte_devargs

PATCH Applied Gaetan Rivet 4 participants 5 messages Feb 7, 2018 – Feb 14, 2018

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: update deprecation notice of rte_devargs

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.

---
 doc/guides/rel_notes/deprecation.rst | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)
doc/guides/rel_notes/deprecation.rst +16 -11
index d59ad5988..07312f59a 100644
@@ -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:
Signature · 1 line
2.11.0
#3 lore raw

13/02/2018 12:26, Ferruh Yigit:

Quoted 6 lines · Shreyansh Jain
Quoted 5 lines · Gaetan Rivet
Quoted 4 lines

The declaration and identification of devices will change in v18.05.

Remove the precedent deprecation notice

Quoted 8 lines
Quoted 6 lines
Quoted 4 lines

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

#4 lore raw

14/02/2018 00:51, Thomas Monjalon:

Quoted 10 lines

13/02/2018 12:26, Ferruh Yigit:

Quoted 9 lines · Shreyansh Jain
Quoted 8 lines · Gaetan Rivet
Quoted 7 lines

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.

Quoted 7 lines
Quoted 5 lines
Quoted 3 lines
Quoted 1 line

Applied