hbase git commit: HBASE-18050 Add document about the IA.Private classes which appear in IA.LimitedPrivate interfaces

[zh...@apache.org]

Repository: hbase
Updated Branches:
  refs/heads/master abc0afb4d -> f17fa223b


HBASE-18050 Add document about the IA.Private classes which appear in IA.LimitedPrivate interfaces


Project: http://git-wip-us.apache.org/repos/asf/hbase/repo
Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/f17fa223
Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/f17fa223
Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/f17fa223

Branch: refs/heads/master
Commit: f17fa223b57faad02f10b3be24dae64c34996b62
Parents: abc0afb
Author: zhangduo <zh...@apache.org>
Authored: Tue Jun 6 21:00:52 2017 +0800
Committer: zhangduo <zh...@apache.org>
Committed: Thu Jun 8 20:38:19 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/f17fa223/src/main/asciidoc/_chapters/upgrading.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/_chapters/upgrading.adoc b/src/main/asciidoc/_chapters/upgrading.adoc
index 7210040..9984cf5 100644
--- a/src/main/asciidoc/_chapters/upgrading.adoc
+++ b/src/main/asciidoc/_chapters/upgrading.adoc
@@ -127,7 +127,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).
+* 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). Notice that, you may find that the classes which are declared as IA.Private are used as parameter or return value for the interfaces which are declared as IA.LimitedPrivate. This is possible. You should treat the IA.Private object as a monolithic object, which means you can use it as a parameter to call other methods, or return it, but you should never try to access its methods or fields.
 * 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]]