Spdk/deprecation.md
Shuhei Matsumoto 0f3f107d5f nvme: Deprecate spdk_nvme_ctrlr_prepare_for_reset()
Signed-off-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
Change-Id: I3e5d1ef4816187b074dcf12ec4ec2dd42d880b65
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12709
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
2022-05-20 09:17:28 +00:00

879 B

Deprecation

ABI and API 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.

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

nvme

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.