doc: announce API change for net defines/structs/funcs

Message ID 20190410083625.17989-1-olivier.matz@6wind.com
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • doc: announce API change for net defines/structs/funcs
Related show

Checks

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

Commit Message

Olivier Matz April 10, 2019, 8:36 a.m.
As discussed at techboard, the network definitions, structures
and functions will be prefixed by 'rte_'.

Link: http://mails.dpdk.org/archives/dev/2019-February/125033.html
Link: https://mails.dpdk.org/archives/dev/2019-April/129752.html
Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Bruce Richardson April 10, 2019, 9:16 a.m. | #1
On Wed, Apr 10, 2019 at 10:36:25AM +0200, Olivier Matz wrote:
> As discussed at techboard, the network definitions, structures
> and functions will be prefixed by 'rte_'.
> 
> Link: http://mails.dpdk.org/archives/dev/2019-February/125033.html
> Link: https://mails.dpdk.org/archives/dev/2019-April/129752.html
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>

Acked-by: Bruce Richardson <bruce.richardson@intel.com>

> ---
>  doc/guides/rel_notes/deprecation.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index ba39c2d62..36bc21ff8 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -11,6 +11,10 @@ API and ABI deprecation notices are to be posted here.
>  Deprecation Notices
>  -------------------
>  
> +* network includes: Network structures, definitions and functions will
> +  be prefixed by ``rte_`` to resolve conflicts with libc headers.
> +  This change will break many DPDK APIs.
> +
>  * meson: The minimum supported version of meson for configuring and building
>    DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
>    those users with a version earlier than 0.47.1, an updated copy of meson
> -- 
> 2.11.0
>
Ferruh Yigit April 10, 2019, 9:18 a.m. | #2
On 4/10/2019 10:16 AM, Bruce Richardson wrote:
> On Wed, Apr 10, 2019 at 10:36:25AM +0200, Olivier Matz wrote:
>> As discussed at techboard, the network definitions, structures
>> and functions will be prefixed by 'rte_'.
>>
>> Link: http://mails.dpdk.org/archives/dev/2019-February/125033.html
>> Link: https://mails.dpdk.org/archives/dev/2019-April/129752.html
>> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> 
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Thomas Monjalon May 13, 2019, 9:07 p.m. | #3
10/04/2019 11:18, Ferruh Yigit:
> On 4/10/2019 10:16 AM, Bruce Richardson wrote:
> > On Wed, Apr 10, 2019 at 10:36:25AM +0200, Olivier Matz wrote:
> >> As discussed at techboard, the network definitions, structures
> >> and functions will be prefixed by 'rte_'.
> >>
> >> Link: http://mails.dpdk.org/archives/dev/2019-February/125033.html
> >> Link: https://mails.dpdk.org/archives/dev/2019-April/129752.html
> >> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> > 
> > Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied, thanks

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ba39c2d62..36bc21ff8 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -11,6 +11,10 @@  API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
+* network includes: Network structures, definitions and functions will
+  be prefixed by ``rte_`` to resolve conflicts with libc headers.
+  This change will break many DPDK APIs.
+
 * meson: The minimum supported version of meson for configuring and building
   DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
   those users with a version earlier than 0.47.1, an updated copy of meson