Skip to content

Commit 70296a2

Browse files
committed
HBASE-22341 Extended the documentation for deprecating APIs
1 parent e44fe49 commit 70296a2

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

‎src/main/asciidoc/_chapters/upgrading.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ In addition to the usual API versioning considerations HBase has other compatibi
6767
6868
.Client API compatibility
6969
* Allow changing or removing existing client APIs.
70-
* An API needs to be deprecated for a major version before we will change/remove it.
70+
* An API needs to be deprecated for a whole major version before we will change/remove it.
71+
** 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.
7172
* 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.
7273
* 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.
7374
** Example: A user using a newly deprecated API does not need to modify application code with HBase API calls until the next major version.

0 commit comments

Comments
 (0)