Commit 9d0e11d4 authored by Seth Howell's avatar Seth Howell Committed by Ben Walker
Browse files

rdma: clean up the create_transport rpc docs 



Just a couple minor clarifications.

Change-Id: I6c368d263296f742d5bfb0df431d3bf40c800c6c
Signed-off-by: default avatarSeth Howell <seth.howell@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/452270


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent eb6006c2

doc/jsonrpc.md

+1 −0
Original line number Diff line number Diff line
@@ -3485,6 +3485,7 @@ io_unit_size | Optional | number | I/O unit size (bytes) 
max_aq_depth                | Optional | number  | Max number of admin cmds per AQ

num_shared_buffers          | Optional | number  | The number of pooled data buffers available to the transport

buf_cache_size              | Optional | number  | The number of shared buffers to reserve for each poll group

max_srq_depth               | Optional | number  | The number of elements in a per-thread shared receive queue (RDMA only)



### Example:

scripts/rpc/nvmf.py

+2 −2
Original line number Diff line number Diff line
@@ -58,7 +58,7 @@ def nvmf_create_transport(client, 
        max_aq_depth: Max size admin quque per controller (optional)

        num_shared_buffers: The number of pooled data buffers available to the transport (optional)

        buf_cache_size: The number of shared buffers to reserve for each poll group (optional)

        max_srq_depth: Max number of outstanding I/O per shared receive queue (optional)

        max_srq_depth: Max number of outstanding I/O per shared receive queue - RDMA specific (optional)



    Returns:

        True or False