From 039ab97c48896a1a1bfd7e8812f15b296c50f997 Mon Sep 17 00:00:00 2001
From: Monica Kenguva <monica.kenguva@intel.com>
Date: Fri, 5 Mar 2021 23:22:40 +0000
Subject: [PATCH] rpc: Document split bdev create and delete

Signed-off-by: Monica Kenguva <monica.kenguva@intel.com>
Change-Id: I3aba1fe4420830a06c9813d224417201e6ba594d
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6753
Community-CI: Broadcom CI
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
---
 doc/jsonrpc.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md
index 4355df07d..ac8a8592a 100644
--- a/doc/jsonrpc.md
+++ b/doc/jsonrpc.md
@@ -7268,6 +7268,86 @@ Example response:
 }
 ~~~
 
+# SPLIT
+
+## bdev_split_create {#rpc_bdev_split_create}
+
+This is used to split an underlying block device and create several smaller equal-sized vbdevs.
+
+### Parameters
+
+Name                    | Optional | Type        | Description
+----------------------- | -------- | ----------- | -----------
+base_bdev               | Required | string      | base bdev name
+split_count             | Required | number      | number of splits
+split_size_mb           | Optional | number      | size in MB to restrict the size
+
+### Example
+
+Example request:
+
+~~~
+{
+  "jsonrpc": "2.0",
+  "method": "bdev_split_create",
+  "id": 1,
+  "params": {
+    "base_bdev": "Malloc0",
+    "split_count": 4
+  }
+}
+~~~
+
+Example response:
+
+~~~
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": [
+    "Malloc0p0",
+    "Malloc0p1",
+    "Malloc0p2",
+    "Malloc0p3"
+  ]
+}
+~~~
+
+## bdev_split_delete {#rpc_bdev_split_delete}
+
+This is used to remove the split vbdevs.
+
+### Parameters
+
+Name                    | Optional | Type        | Description
+----------------------- | -------- | ----------- | -----------
+base_bdev               | Required | string      | base bdev name
+
+### Example
+
+Example request:
+
+~~~
+{
+  "jsonrpc": "2.0",
+  "method": "bdev_split_delete",
+  "id": 1,
+  "params": {
+    "base_bdev": "Malloc0"
+  }
+}
+~~~
+
+Example response:
+
+~~~
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": true
+}
+~~~
+
 # OPAL
 
 ## bdev_nvme_opal_init {#rpc_bdev_nvme_opal_init}