[dpdk-dev] doc: deprecation note for renaming vfio symbols for exporting

Message ID 1486987308-28647-1-git-send-email-shreyansh.jain@nxp.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

Shreyansh Jain Feb. 13, 2017, 12:01 p.m. UTC
  Some vfio symbols need to be exported outside librte_eal. For that, they
need to be renamed to rte_* naming convention.

Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

John McNamara Feb. 14, 2017, 12:46 a.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Shreyansh Jain
> Sent: Monday, February 13, 2017 12:02 PM
> To: dev@dpdk.org
> Cc: Burakov, Anatoly <anatoly.burakov@intel.com>;
> thomas.monjalon@6wind.com; Shreyansh Jain <shreyansh.jain@nxp.com>
> Subject: [dpdk-dev] [PATCH] doc: deprecation note for renaming vfio
> symbols for exporting
> 
> Some vfio symbols need to be exported outside librte_eal. For that, they
> need to be renamed to rte_* naming convention.
> 
> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Jerin Jacob Feb. 14, 2017, 3:26 a.m. UTC | #2
On Mon, Feb 13, 2017 at 05:31:48PM +0530, Shreyansh Jain wrote:
> Some vfio symbols need to be exported outside librte_eal. For that, they
> need to be renamed to rte_* naming convention.
> 
> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index b12d435..092eb2e 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -61,3 +61,9 @@ Deprecation Notices
>    PMDs that implement the latter.
>    Target release for removal of the legacy API will be defined once most
>    PMDs have switched to rte_flow.
> +
> +* Some vfio APIs are planned to be exported outside librte_eal in 17.05.
> +  vfio APIs like ``vfio_setup_device``, ``vfio_get_group_fd`` can be used by
> +  subsystem other than EAL/PCI. For that, these need to be exported symbols.
> +  Such APIs are planned to be renamed according to ``rte_*`` naming convention
> +  and exported from librte_eal.

Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
  
Ferruh Yigit Feb. 14, 2017, 11:39 a.m. UTC | #3
On 2/13/2017 12:01 PM, Shreyansh Jain wrote:
> Some vfio symbols need to be exported outside librte_eal. For that, they
> need to be renamed to rte_* naming convention.
> 
> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Thomas Monjalon Feb. 14, 2017, 7:18 p.m. UTC | #4
Applied
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index b12d435..092eb2e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -61,3 +61,9 @@  Deprecation Notices
   PMDs that implement the latter.
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
+
+* Some vfio APIs are planned to be exported outside librte_eal in 17.05.
+  vfio APIs like ``vfio_setup_device``, ``vfio_get_group_fd`` can be used by
+  subsystem other than EAL/PCI. For that, these need to be exported symbols.
+  Such APIs are planned to be renamed according to ``rte_*`` naming convention
+  and exported from librte_eal.