Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [eclemma-dev] Let's make EclEmma 3.0.0 free of a legacy not necessarily used APIs

On 03/08/2017 02:24 AM, Evgeny Mandrikov wrote:
Hi guys,
Hi,
So seems that the only remaining question - what is preferred way to do this?
1) Marc proposed to simply keep packages as is and only mark them as "x-internal".
That's IMHO simple and clear enough. The "x-internal" option is correctly used by PDE and highlights any usage of those APIs as a warning.

I personally don't like this option. Also https://wiki.eclipse.org/Naming_Conventions#API_Packages clearly states that non-API package should be explicitly be named "internal".
2) Actually do renaming of packages. I might be wrong, but seems that "internal.provisional" is a good fit ( https://wiki.eclipse.org/Provisional_API_Guidelines ).
I tend to believe that those guidelines aren't very pragmatic. If you have something that's intended to become an API, then renaming it to "internal.provisional" to rename it later to some other package is an API breakage, so it's not really nice for adopters.
Also, do you already plan to have "provisional" APIs? If you can avoid them as long as no-one asks for them, it's simpler for EclEmma.
Allowing to keep clean distinction between what "org.eclipse.eclemma.ui" can use and what should not.
'x-friend' allows to do that too.

If I were to do the work, I'd choose the x-internal/x-friend solution.
However, any of these solutions would work and both are totally acceptable. It's more a matter of taste than a matter of correctness IMO.

HTH
--
Mickael Istria
Eclipse developer for Red Hat Developers
My blog - My Tweets

Back to the top