Tomasz Zawadzki 67d8b8d505 deprecation: add the md to documentation Makefile

Originally deprecation.md was pulled verbatim to
the built documentation. This resulted in very
weird paths on the spdk.io:
https://spdk.io/doc/md__home_sys_sgsw_oss_spdk_github_io_spdk_deprecation.html#deprecation

Use the way that changelog does it, by copying
the file and adding appropriate section links.

Now only the Doxygen version will contain the
section links. Meanwhile deprecation.md in
project root will not. This improves readability.

Change-Id: Ic5c1caf7603b847b3c7445bde76e277ba1ccb740
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/16574
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>

2023-05-09 17:58:11 +08:00

3.1 KiB

Raw Blame History

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.

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

PMDK

PMDK is no longer supported and integrations with it in SPDK are now deprecated, and will be removed in SPDK 23.05. Please see: UPDATE ON PMDK AND OUR LONG TERM SUPPORT STRATEGY.

`libreduce_pm_file`

Reduce library will no longer depend on libpmem. pm_file_dir parameter in spdk_reduce_vol_init() will no longer point to pmem device or pmem file. Instead it will be possible to operate on a file, without the benefits of persistency.

VTune

`vtune_support`

VTune integration is in now deprecated and will be removed in SPDK 23.05.

OCF

`bdev_ocf`

The Open CAS Framework (OCF) integration via bdev module and env_ocf is currently marked deprecated due to discontinued support from Intel. However, Huawei is working to pick up support for these components, and the OCF project in general. This code will definitely remain in SPDK 23.05 release, in fact it is likely deprecation notice will be removed by then.

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.

gpt

`old_gpt_guid`

Deprecated the SPDK partition type GUID 7c5222bd-8f5d-4087-9c00-bf9843c7b58c. Partitions of this type have bdevs created that are one block less than the actual size of the partition. Existing partitions using the deprecated GUID can continue to use that GUID; support for the deprecated GUID will remain in SPDK indefinitely, and will continue to exhibit the off-by-one bug so that on-disk metadata layouts based on the incorrect size are not affected.

See GitHub issue 2801 for additional details on the bug.

New SPDK partition types should use GUID 6527994e-2c5a-4eec-9613-8f5944074e8b which will create a bdev of the correct size.

lvol

`vbdev_lvol_rpc_req_size`

Param size in rpc commands rpc_bdev_lvol_create and rpc_bdev_lvol_resize is deprecated and replace by size_in_mib.

See GitHub issue 2346 for additional details.

3.1 KiB Raw Blame History