[dpdk-dev] [PATCH 3/3] lib: remind experimental status in library headers
Honnappa Nagarahalli
Honnappa.Nagarahalli at arm.com
Thu May 28 20:40:57 CEST 2020
<snip>
>
> Hello Honnappa,
>
> On Fri, May 22, 2020 at 4:16 PM Honnappa Nagarahalli
> <Honnappa.Nagarahalli at arm.com> wrote:
> > > @@ -11,7 +11,8 @@
> > > * Wireless base band device abstraction APIs.
> > > *
> > > * @warning
> > > - * @b EXPERIMENTAL: this API may change without prior notice
> > > + * @b EXPERIMENTAL:
> > > + * All functions in this file may change or disappear without prior notice.
> > nit, is 'removed' a better choice instead of 'disappear'? May be something
> like:
> > All functions in this file may be changed or removed without prior notice.
>
> I used the same form than in the abi policy (that I wanted but forgot to
> update in patch 1 afterwards... will be fixed in v2).
>
> #. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may
> change without constraint, as they are not considered part of an ABI version.
> Experimental libraries have the major ABI version ``0``.
>
> No strong opinion, but I prefer keeping a single phrasing.
> If we go with your suggestion, I will update the abi policy.
Agree on using the same wording.
IMO, we should capture the 'removed/disappear' wording in the ABI policy.
>
>
> --
> David Marchand
More information about the dev
mailing list