diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d3073262..6386a618c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,9 @@ New options `psk_key` and `psk_identity` were added to the `sock_impl_set_option Added warning message for `bdev_rbd_create`, if it is used without -c. `bdev_rbd_create()` API without specifying -c is deprecated and will be removed in future release. +Renamed `enable_vmd` RPC to `vmd_enable` to make it consistent with our naming scheme of +`_`. For now, the old name is still available, but is marked as deprecated. + ### raid Renamed the `raid5` module to `raid5f` to reflect that it is not a traditional diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index a1aca28bc..3ef69e2a4 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -9963,7 +9963,7 @@ Example response: } ~~~ -### enable_vmd {#rpc_enable_vmd} +### vmd_enable {#rpc_enable_vmd} Enable VMD enumeration. @@ -9982,7 +9982,7 @@ Example request: ~~~json { "jsonrpc": "2.0", - "method": "enable_vmd", + "method": "vmd_enable", "id": 1 } ~~~ diff --git a/doc/vmd.md b/doc/vmd.md index 464241e06..56c5432ec 100644 --- a/doc/vmd.md +++ b/doc/vmd.md @@ -85,7 +85,7 @@ JSON config: "subsystem": "vmd", "config": [ { - "method": "enable_vmd", + "method": "vmd_enable", "params": {} } ] @@ -95,7 +95,7 @@ JSON config: or use RPC call before framework starts e.g. ``` $ ./build/bin/spdk_tgt --wait_for_rpc -$ ./scripts/rpc.py enable_vmd +$ ./scripts/rpc.py vmd_enable $ ./scripts/rpc.py framework_start_init ``` ## Applications w/o application framework {#vmd_app} diff --git a/module/event/subsystems/vmd/vmd.c b/module/event/subsystems/vmd/vmd.c index 1348fc423..6062bf3fe 100644 --- a/module/event/subsystems/vmd/vmd.c +++ b/module/event/subsystems/vmd/vmd.c @@ -74,7 +74,7 @@ vmd_write_config_json(struct spdk_json_write_ctx *w) if (g_enabled) { spdk_json_write_object_begin(w); - spdk_json_write_named_string(w, "method", "enable_vmd"); + spdk_json_write_named_string(w, "method", "vmd_enable"); spdk_json_write_named_object_begin(w, "params"); spdk_json_write_object_end(w); spdk_json_write_object_end(w); diff --git a/module/event/subsystems/vmd/vmd_rpc.c b/module/event/subsystems/vmd/vmd_rpc.c index bd204a2ed..df7164071 100644 --- a/module/event/subsystems/vmd/vmd_rpc.c +++ b/module/event/subsystems/vmd/vmd_rpc.c @@ -18,5 +18,5 @@ rpc_vmd_enable(struct spdk_jsonrpc_request *request, const struct spdk_json_val spdk_jsonrpc_send_bool_response(request, true); } - -SPDK_RPC_REGISTER("enable_vmd", rpc_vmd_enable, SPDK_RPC_STARTUP) +SPDK_RPC_REGISTER("vmd_enable", rpc_vmd_enable, SPDK_RPC_STARTUP) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(vmd_enable, enable_vmd) diff --git a/python/spdk/rpc/vmd.py b/python/spdk/rpc/vmd.py index 067271ef1..cfcaafe65 100644 --- a/python/spdk/rpc/vmd.py +++ b/python/spdk/rpc/vmd.py @@ -1,3 +1,7 @@ -def enable_vmd(client): +from .helpers import deprecated_alias + + +@deprecated_alias('enable_vmd') +def vmd_enable(client): """Enable VMD enumeration.""" - return client.call('enable_vmd') + return client.call('vmd_enable') diff --git a/scripts/rpc.py b/scripts/rpc.py index f71bcd103..7834ac059 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -2067,11 +2067,11 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse p.set_defaults(func=bdev_ftl_delete) # vmd - def enable_vmd(args): - print_dict(rpc.vmd.enable_vmd(args.client)) + def vmd_enable(args): + print_dict(rpc.vmd.vmd_enable(args.client)) - p = subparsers.add_parser('enable_vmd', help='Enable VMD enumeration') - p.set_defaults(func=enable_vmd) + p = subparsers.add_parser('vmd_enable', aliases=['enable_vmd'], help='Enable VMD enumeration') + p.set_defaults(func=vmd_enable) # nbd def nbd_start_disk(args): diff --git a/test/vmd/vmd.sh b/test/vmd/vmd.sh index 88b6178a2..88f648b4a 100755 --- a/test/vmd/vmd.sh +++ b/test/vmd/vmd.sh @@ -34,7 +34,7 @@ function vmd_bdev_svc() { # Wait until bdev_svc starts waitforlisten $svcpid - $rpc_py enable_vmd + $rpc_py vmd_enable $rpc_py framework_start_init for bdf in $pci_devs; do