vmd: rename enable_vmd RPC to vmd_enable

The new name is consistent with the naming scheme of
<subsystem>_<action> that all of our other RPCs use.

Signed-off-by: Konrad Sztyber <konrad.sztyber@intel.com>
Change-Id: I2cae7af5715add8eba26501cd192a6ac4884ec69
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/13952
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Tom Nabarro <tom.nabarro@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>

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
+`<subsystem>_<action>`.  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

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
 }
 ~~~

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}

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);

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)

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')

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):

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