[dpdk-dev] [PATCH] doc: mark internal symbols in ethdev
Thomas Monjalon
thomas at monjalon.net
Fri Jul 10 16:20:43 CEST 2020
26/06/2020 10:49, Kinsella, Ray:
> On 23/06/2020 14:49, Ferruh Yigit wrote:
> > The APIs are marked in the doxygen comment but better to mark the
> > symbols too. This is planned for v20.11 release.
> >
> > Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
> > ---
> > +* ethdev: Some internal APIs for driver usage are exported in the .map file.
> > + Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move
> > + them to the INTERNAL block in .map. Although these APIs are internal it will
> > + break the ABI checks, that is why change is planned for 20.11.
> > + The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``.
> > +
>
> Acked-by: Ray Kinsella <mdr at ashroe.eu>
>
> A bunch of other folks have already annotated "internal" APIs, and added entries to
> libabigail.abignore to suppress warnings. If you are 100% certain these are never used
> by end applications, you could do likewise.
>
> That said, depreciation notice and completing in 20.11 is definitely the better approach.
> See https://git.dpdk.org/dpdk/tree/devtools/libabigail.abignore#n53
I agree we can wait 20.11.
Acked-by: Thomas Monjalon <thomas at monjalon.net>
More information about the dev
mailing list