rpc: revise comments for construct_nvme_bdev

Just considering the situation of multi-namespaces device.

Change-Id: I1b0d502874ab53891060c973a3ae75e81ec591f2
Signed-off-by: Liu Xiaodong <xiaodong.liu@intel.com>
Reviewed-on: https://review.gerrithub.io/431698
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Vitaliy Mysak <vitaliy.mysak@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
This commit is contained in:
Liu Xiaodong 2018-11-01 12:16:56 -04:00 committed by Jim Harris
parent 8fa8310be4
commit 98187ed9a7
3 changed files with 5 additions and 5 deletions

View File

@ -996,7 +996,7 @@ Array of names of newly created bdevs.
Name | Optional | Type | Description Name | Optional | Type | Description
----------------------- | -------- | ----------- | ----------- ----------------------- | -------- | ----------- | -----------
name | Required | string | Bdev name name | Required | string | Name of the NVMe controller, prefix for each bdev name
trtype | Required | string | NVMe-oF target trtype: rdma or pcie trtype | Required | string | NVMe-oF target trtype: rdma or pcie
traddr | Required | string | NVMe-oF target address: ip or BDF traddr | Required | string | NVMe-oF target address: ip or BDF
adrfam | Optional | string | NVMe-oF target adrfam: ipv4, ipv6, ib, fc, intra_host adrfam | Optional | string | NVMe-oF target adrfam: ipv4, ipv6, ib, fc, intra_host

View File

@ -278,8 +278,8 @@ if __name__ == "__main__":
subnqn=args.subnqn)) subnqn=args.subnqn))
p = subparsers.add_parser('construct_nvme_bdev', p = subparsers.add_parser('construct_nvme_bdev',
help='Add bdev with nvme backend') help='Add bdevs with nvme backend')
p.add_argument('-b', '--name', help="Name of the bdev", required=True) p.add_argument('-b', '--name', help="Name of the NVMe controller, prefix for each bdev name", required=True)
p.add_argument('-t', '--trtype', p.add_argument('-t', '--trtype',
help='NVMe-oF target trtype: e.g., rdma, pcie', required=True) help='NVMe-oF target trtype: e.g., rdma, pcie', required=True)
p.add_argument('-a', '--traddr', p.add_argument('-a', '--traddr',

View File

@ -216,7 +216,7 @@ def set_bdev_nvme_hotplug(client, enable, period_us=None):
def construct_nvme_bdev(client, name, trtype, traddr, adrfam=None, trsvcid=None, subnqn=None): def construct_nvme_bdev(client, name, trtype, traddr, adrfam=None, trsvcid=None, subnqn=None):
"""Construct NVMe namespace block device. """Construct NVMe namespace block devices.
Args: Args:
name: bdev name prefix; "n" + namespace ID will be appended to create unique names name: bdev name prefix; "n" + namespace ID will be appended to create unique names
@ -227,7 +227,7 @@ def construct_nvme_bdev(client, name, trtype, traddr, adrfam=None, trsvcid=None,
subnqn: subsystem NQN to connect to (optional) subnqn: subsystem NQN to connect to (optional)
Returns: Returns:
Name of created block device. Names of created block devices.
""" """
params = {'name': name, params = {'name': name,
'trtype': trtype, 'trtype': trtype,