HBASE-22341 Extended the documentation for deprecating APIs

This commit is contained in:
Jan Hentschel 2019-04-30 12:26:44 +02:00
parent 630ac33fb0
commit d3cf01d006
No known key found for this signature in database
GPG Key ID: 5CD818B19CC299A3
1 changed files with 2 additions and 1 deletions

View File

@ -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 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.
* Example: A user using a newly deprecated api does not need to modify application code with hbase api calls until the next major version.