From: "Kinsella, Ray" <mdr@ashroe.eu>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: dev@dpdk.org, bruce.richardson@intel.com,
john.mcnamara@intel.com, roretzla@linux.microsoft.com,
ferruh.yigit@intel.com, david.marchand@redhat.com,
stephen@networkplumber.org, jerinjacobk@gmail.com
Subject: Re: [dpdk-dev] [PATCH v5] doc: policy on the promotion of experimental APIs
Date: Wed, 4 Aug 2021 12:49:23 +0100 [thread overview]
Message-ID: <11118c95-d65f-ad71-0d46-b627cf641b62@ashroe.eu> (raw)
In-Reply-To: <2298571.ajXUNpiJai@thomas>
On 04/08/2021 11:39, Thomas Monjalon wrote:
> 04/08/2021 11:34, Ray Kinsella:
>> Clarifying the ABI policy on the promotion of experimental APIS to stable.
>> We have a fair number of APIs that have been experimental for more than
>> 2 years. This policy amendment indicates that these APIs should be
>> promoted or removed, or should at least form a conservation between the
>
> s/conservation/conversation/
>
>> maintainer and original contributor.
>>
>> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
>> Acked-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
>> ---
>> +#. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may be
>> + changed or removed without prior notice, as they are not considered part of
>> + an ABI version. The :ref:`experimental <experimental_apis>` status of an API
>> + is not an indefinite state.
> [...]
>> +Promotion to stable
>> +~~~~~~~~~~~~~~~~~~~
>> +
>> +An API's ``experimental`` status should be reviewed annually, by both the
>> +maintainer and/or the original contributor. Ordinarily APIs marked as
>> +``experimental`` will be promoted to the stable ABI once a maintainer has become
>> +satisfied that the API is mature and is unlikely to change.
>> +
>> +In exceptional circumstances, should an API still be classified as
>> +``experimental`` after two years and is without any prospect of becoming part of
>> +the stable API. The API will then become a candidate for removal, to avoid the
>> +accumulation of abandoned symbols.
>> +
>> +Should an API's Binary Interface change, usually due to a direct change to the
>
> API's Binary Interface?
> I assume you mean ABI.
>
>> +API's signature, it is reasonable for the review and expiry clocks to reset. The
>> +promotion or removal of symbols will typically form part of a conversation
>> +between the maintainer and the original contributor.
>
> Acked-by: Thomas Monjalon <thomas@monjalon.net>
>
> Applied with above changes, thanks.
>
Thanks.
prev parent reply other threads:[~2021-08-04 11:49 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-29 16:00 [dpdk-dev] [PATCH v1] doc: policy on " Ray Kinsella
2021-06-29 16:28 ` Tyler Retzlaff
2021-06-29 18:38 ` Kinsella, Ray
2021-06-30 19:56 ` Tyler Retzlaff
2021-07-01 7:56 ` Ferruh Yigit
2021-07-01 14:45 ` Tyler Retzlaff
2021-07-01 10:19 ` Kinsella, Ray
2021-07-01 15:09 ` Tyler Retzlaff
2021-07-02 6:30 ` Kinsella, Ray
2021-07-01 10:31 ` [dpdk-dev] [PATCH v2] " Ray Kinsella
2021-07-01 10:38 ` [dpdk-dev] [PATCH v3] doc: policy on the " Ray Kinsella
2021-07-07 18:32 ` Tyler Retzlaff
2021-07-09 6:16 ` Jerin Jacob
2021-07-09 19:15 ` Tyler Retzlaff
2021-07-11 7:22 ` Jerin Jacob
2021-08-03 14:12 ` Kinsella, Ray
2021-08-03 16:44 ` [dpdk-dev] [PATCH v4] " Ray Kinsella
2021-08-04 9:34 ` [dpdk-dev] [PATCH v5] " Ray Kinsella
2021-08-04 10:39 ` Thomas Monjalon
2021-08-04 11:49 ` Kinsella, Ray [this message]
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=11118c95-d65f-ad71-0d46-b627cf641b62@ashroe.eu \
--to=mdr@ashroe.eu \
--cc=bruce.richardson@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=jerinjacobk@gmail.com \
--cc=john.mcnamara@intel.com \
--cc=roretzla@linux.microsoft.com \
--cc=stephen@networkplumber.org \
--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).