flink-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Robert Metzger <rmetz...@apache.org>
Subject Re: Tagging Flink classes with InterfaceAudience and InterfaceStability
Date Wed, 28 Jan 2015 09:29:46 GMT
I think in Hadoop they use LimitedPrivate for the different components of
the project.
For example LimitedPrivate("yarn").
Here is a very good documentation on the topic:
https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/InterfaceClassification.html

On Tue, Jan 27, 2015 at 3:58 PM, Alexander Alexandrov <
alexander.s.alexandrov@gmail.com> wrote:

> I don't get the difference between Private and LimitedPrivate, but
> otherwise seems like quite a nice idea.
>
> It will be also good if we can agree upon what these tags actually mean and
> add this meaning to the documentation.
>
> 2015-01-27 15:46 GMT+01:00 Robert Metzger <rmetzger@apache.org>:
>
> > Hi,
> >
> > Hadoop has annotations for tagging the stability and audience of classes
> > and methods.
> >
> > Through that, you can have @InterfaceAudience.Public, Private,
> > LimitedPrivate
> > and also @InterfaceStability.Evolving, Unstable, and Stable.
> >
> > I guess there are tools which allow to automatically check if interfaces,
> > which are marked as Stable have been changed between releases (or by pull
> > requests).
> >
> > I think such annotations are crucial if we want to guarantee interface
> > stability between releases.
> >
> > What do you think? Should we add those annotations? Which one would you
> > like to add?
> >
> >
> > Robert
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message