Commit ad272579 authored by Ben Walker's avatar Ben Walker Committed by Jim Harris
Browse files

nvmf: Clarify wording of buf cache size parameter 



I think this wording is slightly more clear.

Change-Id: I9fc500b8b87c0520bdf96e6c5db490bb98121da3
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.gerrithub.io/c/442435


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent 9521d11b

doc/jsonrpc.md

+1 −1
Original line number Diff line number Diff line
@@ -3488,7 +3488,7 @@ max_io_size | Optional | number | Max I/O size (bytes) 
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 cache per poll group

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



### Example:

scripts/rpc.py

+1 −1
Original line number Diff line number Diff line
@@ -1375,7 +1375,7 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse 
    p.add_argument('-u', '--io-unit-size', help='I/O unit size (bytes)', type=int)

    p.add_argument('-a', '--max-aq-depth', help='Max number of admin cmds per AQ', type=int)

    p.add_argument('-n', '--num-shared-buffers', help='The number of pooled data buffers available to the transport', type=int)

    p.add_argument('-b', '--buf-cache-size', help='The number of shared buffers to cache per poll group', type=int)

    p.add_argument('-b', '--buf-cache-size', help='The number of shared buffers to reserve for each poll group', type=int)

    p.set_defaults(func=nvmf_create_transport)



    def get_nvmf_transports(args):

scripts/rpc/nvmf.py

+1 −1
Original line number Diff line number Diff line
@@ -56,7 +56,7 @@ def nvmf_create_transport(client, 
        io_unit_size: I/O unit size in bytes (optional)

        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 cache per poll group (optional)

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



    Returns:

        True or False