From 72d94ca8212a86c3e358e4783eb8dc9fff3dded1 Mon Sep 17 00:00:00 2001
From: Monica Kenguva <monica.kenguva@intel.com>
Date: Thu, 11 Mar 2021 20:42:58 +0000
Subject: [PATCH] rpc: Document env_dpdk_get_mem_stats

Signed-off-by: Monica Kenguva <monica.kenguva@intel.com>
Change-Id: If66d05c14e5758f1b27000d33b4098d73c7a51b3
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6851
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
---
 doc/jsonrpc.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md
index ac9f5a10b..d1f0613d5 100644
--- a/doc/jsonrpc.md
+++ b/doc/jsonrpc.md
@@ -1231,6 +1231,43 @@ Example response:
   }
 }
 ~~~
+
+## env_dpdk_get_mem_stats {#rpc_env_dpdk_get_mem_stats}
+
+Write the dpdk memory stats to a file.
+
+### Parameters
+
+This method has no parameters.
+
+### Response
+
+The response is a pathname to a text file containing the memory stats.
+
+### Example
+
+Example request:
+
+~~~
+{
+  "jsonrpc": "2.0",
+  "method": "env_dpdk_get_mem_stats",
+  "id": 1
+}
+~~~
+
+Example response:
+
+~~~
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": {
+    "filename": "/tmp/spdk_mem_dump.txt"
+  }
+}
+~~~
+
 # Block Device Abstraction Layer {#jsonrpc_components_bdev}
 
 ## bdev_set_options {#rpc_bdev_set_options}