This is an automated email from the ASF dual-hosted git repository. janh pushed a commit to branch branch-1.3 in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/branch-1.3 by this push: new e1b21b3 HBASE-22341 Extended the documentation for deprecating APIs e1b21b3 is described below commit e1b21b31929ab599741a7a0ec597b1694cdd38e1 Author: Jan Hentschel <jan.hentsc...@ultratendency.com> AuthorDate: Tue Apr 30 12:26:44 2019 +0200 HBASE-22341 Extended the documentation for deprecating APIs --- src/main/asciidoc/_chapters/upgrading.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/main/asciidoc/_chapters/upgrading.adoc b/src/main/asciidoc/_chapters/upgrading.adoc index bbdbcb4..7ad2a9f 100644 --- a/src/main/asciidoc/_chapters/upgrading.adoc +++ b/src/main/asciidoc/_chapters/upgrading.adoc @@ -71,7 +71,8 @@ In addition to the usual API versioning considerations HBase has other compatibi .Client API compatibility * Allow changing or removing existing client APIs. -* An API needs to be deprecated for a major version before we will change/remove it. +* An API needs to be deprecated for a whole major version before we will change/remove it. +** An example: An API was deprecated in 2.0.1 and will be marked for deletion in 4.0.0. On the other hand, an API deprecated in 2.0.0 can be removed in 3.0.0. * APIs available in a patch version will be available in all later patch versions. However, new APIs may be added which will not be available in earlier patch versions. * New APIs introduced in a patch version will only be added in a source compatible way footnote:[See 'Source Compatibility' https://blogs.oracle.com/darcy/entry/kinds_of_compatibility]: i.e. code that implements public APIs will continue to compile. * Example: A user using a newly deprecated API does not need to modify application code with HBase API calls until the next major version.