d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
5914f02b2a
numam-spdk/deprecation.md

27 lines
1.1 KiB
Markdown
Raw Normal View History

markdownlint: enable rule MD025 MD025 - Multiple top level headers in the same document Fixed all errors Update check_format.sh to fit new header style in jsonrpc.md Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com> Change-Id: Ib5f832c549880771c99c15b89affe1e82acd3fa4 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9045 Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
2021-08-02 12:27:54 +00:00
# Deprecation
## ABI and API Deprecation {#deprecation}
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-02-26 12:33:12 +00:00
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.
spelling: deprecation.md Part of #2256 * versioning Change-Id: Ibba158baad1d26a264a7329d6645217fad7622c9 Signed-off-by: Josh Soref <jsoref@gmail.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10400 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Reviewed-by: Karol Latecki <karol.latecki@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
2021-11-25 01:40:57 +00:00
ABI versions are managed separately for each library and follow [Semantic Versioning](https://semver.org/).
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-02-26 12:33:12 +00:00
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.
markdownlint: enable rule MD025 MD025 - Multiple top level headers in the same document Fixed all errors Update check_format.sh to fit new header style in jsonrpc.md Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com> Change-Id: Ib5f832c549880771c99c15b89affe1e82acd3fa4 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9045 Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
2021-08-02 12:27:54 +00:00
## Deprecation Notices {#deprecation-notices}
lib/bdev: added spdk_bdev_module_fini_done() Callback for bdev modules is called 'module_fini', meanwhile after its execution bdev modules were to call 'spdk_bdev_module_finish_done()'. This function carries incorrect name, so it was deprecated and replaced with 'spdk_bdev_module_fini_done()'. Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Change-Id: I9a12dff746ea8b4b1570a3794470f7b24e29003e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9148 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
2021-08-10 13:30:42 +00:00
markdownlint: enable rule MD025 MD025 - Multiple top level headers in the same document Fixed all errors Update check_format.sh to fit new header style in jsonrpc.md Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com> Change-Id: Ib5f832c549880771c99c15b89affe1e82acd3fa4 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9045 Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
2021-08-02 12:27:54 +00:00
### bdev
lib/bdev: added spdk_bdev_module_fini_done() Callback for bdev modules is called 'module_fini', meanwhile after its execution bdev modules were to call 'spdk_bdev_module_finish_done()'. This function carries incorrect name, so it was deprecated and replaced with 'spdk_bdev_module_fini_done()'. Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Change-Id: I9a12dff746ea8b4b1570a3794470f7b24e29003e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9148 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
2021-08-10 13:30:42 +00:00
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.
nvme: Add three APIs for disconnect, start re-enable, and poll re-enable ctrlr The NVMe bdev module will support two features, delayed reconnect and delete after multiple failures of reconnect to improve error recovery. The recently added two APIs, spdk_nvme_ctrlr_reset_async() and spdk_nvme_ctrlr_reset_poll_async(), were not good enough. spdk_nvme_ctrlr_reset_ctx was not necessary. It had only a pointer to ctrlr. Using a pointer to ctrlr directly saves us from undesirable malloc error processing. Separate spdk_nvme_ctrlr_reset_async() into spdk_nvme_ctrlr_disconnect() and spdk_nvme_ctrlr_reconnect_async(). spdk_nvme_ctrlr_disconnect() disconnects ctrlr including disconnecting adminq. spdk_nvme_ctrlr_reconnect_async() moves the ctrlr state to INIT. Then rename spdk_nvme_ctrlr_reset_poll_async() by spdk_nvme_ctrlr_reconnect_poll_async(). Finally deprecate spdk_nvme_ctrlr_reset_async() and spdk_nvme_ctrlr_reset_poll_async(). The following patches will change the NVMe bdev module to use these new APIs. Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Change-Id: Id1d6858dcdc5fc2e9db0a6ebf3f79cab4f9bbcb7 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10091 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2021-11-26 18:22:08 +00:00
### 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.
Reference in New Issue Copy Permalink