4a73675dbf
Change spdk_nvme_ctrlr_reset() to use spdk_nvme_ctrlr_disconnect(), spdk_nvme_ctrlr_reconnect_async(), and spdk_nvme_ctrlr_reconnect_poll_async(). Then remove the deprecated spdk_nvme_ctrlr_reset_async() and spdk_nvme_ctrlr_reset_poll_async(). These changes simplify the following patches to make spdk_nvme_ctrlr_disconnect() asynchronous. Change-Id: Ia71e8e0ad5b2dff42b7423634f66de47863926e2 Signed-off-by: Shuhei Matsumoto <smatsumoto@nvidia.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10913 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com>
27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
# Deprecation
|
|
|
|
## ABI and API Deprecation {#deprecation}
|
|
|
|
This document details the policy for maintaining stability of SPDK ABI and API.
|
|
|
|
Major ABI version can change at most once for each quarterly SPDK release.
|
|
ABI versions are managed separately for each library and follow [Semantic Versioning](https://semver.org/).
|
|
|
|
API and ABI deprecation notices shall be posted in the next section.
|
|
Each entry must describe what will be removed and can suggest the future use or alternative.
|
|
Specific future SPDK release for the removal must be provided.
|
|
ABI cannot be removed without providing deprecation notice for at least single SPDK release.
|
|
|
|
## Deprecation Notices {#deprecation-notices}
|
|
|
|
### nvme
|
|
|
|
Deprecated `spdk_nvme_ctrlr_reset_async` and `spdk_nvme_ctrlr_reset_poll_async` APIs,
|
|
which will be removed in SPDK 22.01. `spdk_nvme_ctrlr_disconnect`, `spdk_nvme_ctrlr_reconnect_async`,
|
|
and `spdk_nvme_ctrlr_reconnect_poll_async` should be used instead.
|
|
|
|
### bdev
|
|
|
|
Deprecated `spdk_bdev_module_finish_done()` API, which will be removed in SPDK 22.01.
|
|
Bdev modules should use `spdk_bdev_module_fini_done()` instead.
|