Commit e3a05e99 authored by Jacek Kalwas's avatar Jacek Kalwas Committed by Jim Harris
Browse files

app/examples/test: fix Transport ID usage description 



It is a prework for Transport ID usage util introduction.

Change-Id: I601870a411c1f0036fc511226abbe080c7435a4b
Signed-off-by: default avatarJacek Kalwas <jacek.kalwas@nutanix.com>
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/25857


Reviewed-by: default avatarJim Harris <jim.harris@nvidia.com>
Reviewed-by: default avatarAnkit Kumar <ankit.kumar@samsung.com>
Tested-by: default avatarSPDK Automated Test System <spdkbot@gmail.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: default avatarKonrad Sztyber <ksztyber@nvidia.com>
Community-CI: Mellanox Build Bot
parent 11c8b86b

app/spdk_nvme_discover/discovery_aer.c

+1 −1
Original line number Diff line number Diff line
@@ -108,7 +108,7 @@ usage(char *program_name) 
{

	printf("%s options", program_name);

	printf("\n");

	printf("\t[-r, --transport <fmt> Transport ID for NVMeoF discovery subsystem]\n");

	printf("\t-r, --transport <fmt> Transport ID for NVMeoF discovery subsystem\n");

	printf("\t Format: 'key:value [key:value] ...'\n");

	printf("\t Keys:\n");

	printf("\t  trtype      Transport type (e.g. TCP, RDMA)\n");

app/spdk_nvme_identify/identify.c

+20 −22
Original line number Diff line number Diff line
@@ -2730,29 +2730,27 @@ usage(const char *program_name) 
	printf("%s [options]", program_name);

	printf("\n");

	printf("options:\n");

	printf(" -r trid    remote NVMe over Fabrics target address\n");

	printf("    Format: 'key:value [key:value] ...'\n");

	printf("    Keys:\n");

	printf("     trtype      Transport type (e.g. RDMA)\n");

	printf("     adrfam      Address family (e.g. IPv4, IPv6)\n");

	printf("     traddr      Transport address (e.g. 192.168.100.8)\n");

	printf("     trsvcid     Transport service identifier (e.g. 4420)\n");

	printf("     subnqn      Subsystem NQN (default: %s)\n", SPDK_NVMF_DISCOVERY_NQN);

	printf("     hostnqn     Host NQN\n");

	printf("    Example: -r 'trtype:RDMA adrfam:IPv4 traddr:192.168.100.8 trsvcid:4420'\n");



	printf("\t[-r trid    Transport ID for local PCIe NVMe or NVMeoF]\n");

	printf("\t   Format: 'key:value [key:value] ...'\n");

	printf("\t   Keys:\n");

	printf("\t    trtype      Transport type (e.g. RDMA)\n");

	printf("\t    adrfam      Address family (e.g. IPv4, IPv6)\n");

	printf("\t    traddr      Transport address (e.g. 192.168.100.8)\n");

	printf("\t    trsvcid     Transport service identifier (e.g. 4420)\n");

	printf("\t    subnqn      Subsystem NQN (default: %s)\n", SPDK_NVMF_DISCOVERY_NQN);

	printf("\t    hostnqn     Host NQN\n");

	printf("\t   Example: -r 'trtype:RDMA adrfam:IPv4 traddr:192.168.100.8 trsvcid:4420'\n");

	spdk_log_usage(stdout, "-L");



	printf(" -i         shared memory group ID\n");

	printf(" -p         core number in decimal to run this application which started from 0\n");

	printf(" -d         DPDK huge memory size in MB\n");

	printf(" -g         use single file descriptor for DPDK memory segments\n");

	printf(" -v         IOVA mode ('pa' or 'va')\n");

	printf(" -x         print hex dump of raw data\n");

	printf(" -z         For NVMe Zoned Namespaces, dump the full zone report (-z) or the first N entries (-z N)\n");

	printf(" -V         enumerate VMD\n");

	printf(" -S         socket implementation, e.g. -S uring (default is posix)\n");

	printf(" -H         show this usage\n");

	printf("\t-i         shared memory group ID\n");

	printf("\t-p         core number in decimal to run this application which started from 0\n");

	printf("\t-d         DPDK huge memory size in MB\n");

	printf("\t-g         use single file descriptor for DPDK memory segments\n");

	printf("\t-v         IOVA mode ('pa' or 'va')\n");

	printf("\t-x         print hex dump of raw data\n");

	printf("\t-z         For NVMe Zoned Namespaces, dump the full zone report (-z) or the first N entries (-z N)\n");

	printf("\t-V         enumerate VMD\n");

	printf("\t-S         socket implementation, e.g. -S uring (default is posix)\n");

	printf("\t-H         show this usage\n");

}



static int

app/spdk_nvme_perf/perf.c

+1 −1
Original line number Diff line number Diff line
@@ -1895,7 +1895,7 @@ usage(char *program_name) 
	printf("\t-a, --warmup-time <sec> warmup time in seconds\n");

	printf("\t-c, --core-mask <mask> core mask for I/O submission/completion.\n");

	printf("\t\t(default: 1)\n");

	printf("\t-r, --transport <fmt> Transport ID for local PCIe NVMe or NVMeoF\n");

	printf("\t[-r, --transport <fmt> Transport ID for local PCIe NVMe or NVMeoF]\n");

	printf("\t\t Format: 'key:value [key:value] ...'\n");

	printf("\t\t Keys:\n");

	printf("\t\t  trtype      Transport type (e.g. PCIe, RDMA)\n");

examples/nvme/abort/abort.c

+2 −0
Original line number Diff line number Diff line
@@ -560,8 +560,10 @@ usage(char *program_name) 
	printf("\t  traddr      Transport address (e.g. 0000:04:00.0 for PCIe or 192.168.100.8 for RDMA)\n");

	printf("\t  trsvcid     Transport service identifier (e.g. 4420)\n");

	printf("\t  subnqn      Subsystem NQN (default: %s)\n", SPDK_NVMF_DISCOVERY_NQN);

	printf("\t  ns          NVMe namespace ID (all active namespaces are used by default)");

	printf("\t Example: -r 'trtype:PCIe traddr:0000:04:00.0' for PCIe or\n");

	printf("\t          -r 'trtype:RDMA adrfam:IPv4 traddr:192.168.100.8 trsvcid:4420' for NVMeoF\n");

	printf("\t\t Note: can be specified multiple times to test multiple disks/targets.\n");

	printf("\t[-s DPDK huge memory size in MB.]\n");

	printf("\t[-i shared memory group ID]\n");

	printf("\t[-a abort interval.]\n");

examples/nvme/arbitration/arbitration.c

+1 −1
Original line number Diff line number Diff line
@@ -482,7 +482,7 @@ usage(char *program_name) 
	printf("\t\t(0 - disabled; 1 - enabled)\n");

	printf("\t[-n subjected IOs for performance comparison]\n");

	printf("\t[-i shared memory group ID]\n");

	printf("\t[-r remote NVMe over Fabrics target address]\n");

	printf("\t[-r Transport ID for local PCIe NVMe or NVMeoF]\n");

	printf("\t[-g use single file descriptor for DPDK memory segments]\n");

}