Commit c5224a96 authored by Jim Harris's avatar Jim Harris Committed by Tomasz Zawadzki
Browse files

ocf: clarify deprecation notice 



Huawei is working on picking up support for OCF and the
associated SPDK bdev module, after Intel discontinued
support.  So clarify various docs and strings to
reflect this for now.  If everything goes according
to plan, deprecation notice will get removed before
23.05 release.  If not, SPDK will just keep the
deprecation notice for 23.05, keep the code in-tree,
and give another release cycle to get things worked
out.

Signed-off-by: default avatarJim Harris <james.r.harris@intel.com>
Change-Id: I9ac6bf2f509005956440b41516ca00b0c1997361
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/17085


Community-CI: Mellanox Build Bot
Reviewed-by: default avatarAmir Haroush <amir.haroush@huawei.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 8e373044

configure

+0 −1
Original line number Diff line number Diff line
@@ -1115,7 +1115,6 @@ if echo -e '#include <uuid/uuid.h>\nint main(void) { uuid_generate_sha1(NULL, NU 
fi



if [[ "${CONFIG[OCF]}" = "y" ]]; then

	echo "WARNING: OCF - bdev_ocf is deprecated."

	# If OCF_PATH is a file, assume it is a library and use it to compile with

	if [ -f ${CONFIG[OCF_PATH]} ]; then

		CONFIG[CUSTOMOCF]=y

deprecation.md

+5 −2
Original line number Diff line number Diff line
@@ -44,8 +44,11 @@ VTune integration is in now deprecated and will be removed in SPDK 23.05. 


#### `bdev_ocf`



The Open CAS Framework (OCF) integration via bdev module and env_ocf is now deprecated

and will be removed in SPDK 23.05.

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

module/bdev/ocf/vbdev_ocf.c

+4 −3
Original line number Diff line number Diff line
@@ -1256,7 +1256,10 @@ error_free: 
	return rc;

}



SPDK_LOG_DEPRECATION_REGISTER(bdev_ocf, "bdev_ocf support", "SPDK 23.05", 0);

/* This deprecation is likely to be removed, and the ocf support will remain

 * in SPDK.  See deprecation.md for more details.

 */

SPDK_LOG_DEPRECATION_REGISTER(bdev_ocf, "bdev_ocf support", "SPDK 23.09", 0);



/* Read configuration file at the start of SPDK application

 * This adds vbdevs to global list if some mentioned in config */
@@ -1265,8 +1268,6 @@ vbdev_ocf_init(void) 
{

	int status;



	SPDK_LOG_DEPRECATED(bdev_ocf);



	status = vbdev_ocf_ctx_init();

	if (status) {

		SPDK_ERRLOG("OCF ctx initialization failed with=%d\n", status);