ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
c06df11513
Spdk/deprecation.md
Tomasz Zawadzki 9a3877213e deprecation: add a file to gather all deprecation notices 
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: I66e442c4d10c1d40f4d9240f4f48374fc6966f29
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6591
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: <dongx.yi@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
2021-04-26 06:55:03 +00:00

1.5 KiB
Raw Blame History

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 Versoning.

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

net

The net library is deprecated and will be removed in the 21.07 release.

nvmf

The following APIs have been deprecated and will be removed in SPDK 21.07:

  • spdk_nvmf_poll_group_get_stat (function in nvmf.h),
  • spdk_nvmf_transport_poll_group_get_stat (function in nvmf.h),
  • spdk_nvmf_transport_poll_group_free_stat(function in nvmf.h),
  • spdk_nvmf_rdma_device_stat (struct in nvmf.h),
  • spdk_nvmf_transport_poll_group_stat (struct in nvmf.h),
  • poll_group_get_stat (transport op in nvmf_transport.h),
  • poll_group_free_stat (transport op in nvmf_transport.h). Please use spdk_nvmf_poll_group_dump_stat and poll_group_dump_stat instead.

rpm

pkg/spdk.spec is considered to be deprecated and scheduled for removal in SPDK 21.07. Please use rpmbuild/spdk.spec instead and see RPM documentation for more details.