HBASE-17858 Update refguide about the IS annotation if necessary
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/17737b27 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/17737b27 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/17737b27 Branch: refs/heads/hbase-12439 Commit: 17737b2710a2a1271eb791478eb99f7a573ecac1 Parents: 029fa29 Author: zhangduo <zhang...@apache.org> Authored: Fri Mar 31 18:20:45 2017 +0800 Committer: zhangduo <zhang...@apache.org> Committed: Thu Apr 6 09:48:18 2017 +0800 ---------------------------------------------------------------------- src/main/asciidoc/_chapters/upgrading.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/17737b27/src/main/asciidoc/_chapters/upgrading.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/upgrading.adoc b/src/main/asciidoc/_chapters/upgrading.adoc index df5bbfe..46f637d 100644 --- a/src/main/asciidoc/_chapters/upgrading.adoc +++ b/src/main/asciidoc/_chapters/upgrading.adoc @@ -128,7 +128,7 @@ for warning about incompatible changes). All effort will be made to provide a de HBase has a lot of API points, but for the compatibility matrix above, we differentiate between Client API, Limited Private API, and Private API. HBase uses a version of link:https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Compatibility.html[Hadoop's Interface classification]. HBase's Interface classification classes can be found link:https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/classification/package-summary.html[here]. * InterfaceAudience: captures the intended audience, possible values are Public (for end users and external projects), LimitedPrivate (for other Projects, Coprocessors or other plugin points), and Private (for internal use). -* InterfaceStability: describes what types of interface changes are permitted. Possible values are Stable, Evolving, Unstable, and Deprecated. +* InterfaceStability: describes what types of interface changes are permitted. Possible values are Stable, Evolving, Unstable, and Deprecated. Notice that this annotation is only valid for classes which are marked as IA.LimitedPrivate. The stability of IA.Public classes is only related to the upgrade type(major, minor or patch). And for IA.Private classes, there is no guarantee on the stability between releases. Refer to the Compatibility Matrix above for more details. [[hbase.client.api]] HBase Client API::
