From: "Kinsella, Ray" <mdr@ashroe.eu>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
Neil Horman <nhorman@tuxdriver.com>,
John McNamara <john.mcnamara@intel.com>,
Marko Kovacevic <marko.kovacevic@intel.com>
Cc: dev@dpdk.org, David Marchand <david.marchand@redhat.com>,
Thomas Monjalon <thomas@monjalon.net>,
Andrew Rybchenko <arybchenko@solarflare.com>
Subject: Re: [dpdk-dev] [PATCH] doc: mark internal symbols in ethdev
Date: Fri, 26 Jun 2020 09:49:02 +0100 [thread overview]
Message-ID: <c13fc802-83ac-bf8c-f8c2-53905319437e@ashroe.eu> (raw)
In-Reply-To: <20200623134952.1273562-1-ferruh.yigit@intel.com>
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@intel.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 0bee92425..0b0f75720 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -98,6 +98,12 @@ Deprecation Notices
> Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
> APIs can be used as replacement.
>
> +* 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@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
> * traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
> ABI stable in the v19.11 release. The TM maintainer and other contributors have
> agreed to keep the TM APIs as experimental in expectation of additional spec
>
next prev parent reply other threads:[~2020-06-26 8:49 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-23 13:49 Ferruh Yigit
2020-06-23 14:29 ` Andrew Rybchenko
2020-06-26 8:49 ` Kinsella, Ray [this message]
2020-07-10 14:20 ` Thomas Monjalon
2020-07-10 16:17 ` Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=c13fc802-83ac-bf8c-f8c2-53905319437e@ashroe.eu \
--to=mdr@ashroe.eu \
--cc=arybchenko@solarflare.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=nhorman@tuxdriver.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).