9d06166f5b
Use the deprecation API to annotate and log the deprecation of spdk_nvme_ctrlr_prepare_for_reset() using the tag "nvme_ctrlr_prepare_for_reset". Signed-off-by: Mike Gerdts <mgerdts@nvidia.com> Change-Id: I98fd840aa9acc028a49bb47daf4ab7e88f1eb818 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15756 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com>
28 lines
1.2 KiB
Markdown
28 lines
1.2 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.
|
|
|
|
Deprecated code paths must be registered with `SPDK_DEPRECATION_REGISTER()` and logged with
|
|
`SPDK_LOG_DEPRECATED()`. The tag used with these macros will appear in the SPDK
|
|
log at the warn level when `SPDK_LOG_DEPRECATED()` is called, subject to rate limits.
|
|
The tags can be matched with the level 4 headers below.
|
|
|
|
## Deprecation Notices {#deprecation-notices}
|
|
|
|
### nvme
|
|
|
|
#### `nvme_ctrlr_prepare_for_reset``
|
|
|
|
Deprecated `spdk_nvme_ctrlr_prepare_for_reset` API, which will be removed in SPDK 22.01.
|
|
For PCIe transport, `spdk_nvme_ctrlr_disconnect` should be used before freeing I/O qpairs.
|