Commit f62eddf1 authored by Tomasz Zawadzki's avatar Tomasz Zawadzki
Browse files

deprecation: push any 24.01 entries to 24.05 



Some of the removals were not followed through
for SPDK 24.01 release.

Move the notices one release forward to match the
actual state of the APIs.

While here fixed minor formatting issue and
made sure that level 4 headers match tags from
the deprecation function.

Signed-off-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/21572

 (master)

(cherry picked from commit a7fba112)
Change-Id: Ia99d0980f31df854aaf2fc1b9c5f8a5737d62290
Signed-off-by: default avatarMarek Chomnicki <marek.chomnicki@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/21600


Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
Tested-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
parent 4a03a9ba

deprecation.md

+6 −6
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ The tags can be matched with the level 4 headers below. 


### accel



#### `flags` parameter in *submit* and *append* functions

#### `accel_flags`



The `int flags` parameter in various *submit* and *append* accel FW API is not used and deprecated. It will be removed

in 24.05 release.
@@ -38,17 +38,17 @@ macro instead. 
#### `spdk_nvmf_qpair_disconnect`



Parameters `cb_fn` and `ctx` of `spdk_nvmf_qpair_disconnect` API are deprecated. These parameters

will be removed in 24.01 release.

will be removed in 24.05 release.



#### `nvmf_get_subsystems`



`transport` field in `listen_addresses` of `nvmf_get_subsystems` RPC is deprecated.

`trtype` field should be used instead. `transport` field will be removed in 24.01 release.

`trtype` field should be used instead. `transport` field will be removed in 24.05 release.



#### 'spdk_nvmf_subsytem_any_listener_allowed'

#### `spdk_nvmf_subsytem_any_listener_allowed`



The function is deprecated and will be removed in 24.01 release. Please use

'spdk_nvmf_subsystem_any_listener_allowed' instead.

The function is deprecated and will be removed in 24.05 release. Please use

`spdk_nvmf_subsystem_any_listener_allowed` instead.



### gpt

include/spdk/nvmf.h

+3 −3
Original line number Diff line number Diff line
@@ -343,8 +343,8 @@ typedef void (*nvmf_qpair_disconnect_cb)(void *ctx); 
 * Disconnect an NVMe-oF qpair

 *

 * \param qpair The NVMe-oF qpair to disconnect.

 * \param cb_fn Deprecated, will be removed in v24.01. The function to call upon completion of the disconnect.

 * \param ctx Deprecated, will be removed in v24.01. The context to pass to the callback function.

 * \param cb_fn Deprecated, will be removed in v24.05. The function to call upon completion of the disconnect.

 * \param ctx Deprecated, will be removed in v24.05. The context to pass to the callback function.

 *

 * \return 0 upon success.

 * \return -ENOMEM if the function specific context could not be allocated.
@@ -801,7 +801,7 @@ void spdk_nvmf_subsystem_allow_any_listener( 
/**

 * Check whether a subsystem allows any listen address or only addresses in the allowed list.

 *

 * Deprecated - will be removed in 24.01. Please use

 * Deprecated - will be removed in v24.05. Please use

 * \ref spdk_nvmf_subsystem_any_listener_allowed.

 *

 * \param subsystem Subsystem to query.

lib/nvmf/nvmf.c

+1 −1
Original line number Diff line number Diff line
@@ -1374,7 +1374,7 @@ _nvmf_qpair_disconnect_msg(void *ctx) 
	free(ctx);

}



SPDK_LOG_DEPRECATION_REGISTER(spdk_nvmf_qpair_disconnect, "cb_fn and ctx are deprecated", "v24.01",

SPDK_LOG_DEPRECATION_REGISTER(spdk_nvmf_qpair_disconnect, "cb_fn and ctx are deprecated", "v24.05",

			      0);



int

lib/nvmf/nvmf_rpc.c

+1 −1
Original line number Diff line number Diff line
@@ -259,7 +259,7 @@ dump_nvmf_subsystem(struct spdk_json_write_ctx *w, struct spdk_nvmf_subsystem *s 


SPDK_LOG_DEPRECATION_REGISTER(rpc_nvmf_get_subsystems,

			      "listener.transport is deprecated in favor of trtype",

			      "v24.01", 0);

			      "v24.05", 0);



static void

rpc_nvmf_get_subsystems(struct spdk_jsonrpc_request *request,

lib/nvmf/subsystem.c

+1 −1
Original line number Diff line number Diff line
@@ -1339,7 +1339,7 @@ spdk_nvmf_subsystem_allow_any_listener(struct spdk_nvmf_subsystem *subsystem, 
}



SPDK_LOG_DEPRECATION_REGISTER(spdk_nvmf_subsytem_any_listener_allowed,

			      "spdk_nvmf_subsytem_any_listener_allowed is deprecated", "v24.01", 0);

			      "spdk_nvmf_subsytem_any_listener_allowed is deprecated", "v24.05", 0);



bool

spdk_nvmf_subsytem_any_listener_allowed(struct spdk_nvmf_subsystem *subsystem)