]> git.ipfire.org Git - thirdparty/iproute2.git/commitdiff
vdpa: Update man page to include vdpa statistics
authorEli Cohen <elic@nvidia.com>
Thu, 21 Jul 2022 06:00:07 +0000 (09:00 +0300)
committerDavid Ahern <dsahern@kernel.org>
Thu, 21 Jul 2022 15:09:07 +0000 (09:09 -0600)
Update the man page to include vdpa statistics information inroduce in
6f97e9c9337b ("vdpa: Add support for reading vdpa device statistics")

Signed-off-by: Eli Cohen <elic@nvidia.com>
Signed-off-by: David Ahern <dsahern@kernel.org>
man/man8/vdpa-dev.8

index 432867c65182a0c5892441c74287142660ae8422..9faf38387e53ec63faf688572a73eeb26bae1652 100644 (file)
@@ -43,6 +43,13 @@ vdpa-dev \- vdpa device configuration
 .B vdpa dev config show
 .RI "[ " DEV " ]"
 
+.ti -8
+.B vdpa dev vstats show
+.I DEV
+.B qidx
+.I QUEUE_INDEX
+
+
 .SH "DESCRIPTION"
 .SS vdpa dev show - display vdpa device attributes
 
@@ -93,6 +100,16 @@ Format is:
 .in +2
 VDPA_DEVICE_NAME
 
+.SS vdpa dev vstats show - shows vendor specific statistics for the given device and virtqueue index. The information is presented as name-value pairs where name is the name of the field and value is a numeric value for it.
+
+.TP
+.BI "DEV"
+- specifies the vdpa device to query
+
+.TP
+.BI qidx " QUEUE_INDEX"
+- specifies the virtqueue index to query
+
 .SH "EXAMPLES"
 .PP
 vdpa dev show
@@ -134,6 +151,11 @@ vdpa dev config show foo
 .RS 4
 Shows the vdpa device configuration of device named foo.
 .RE
+.PP
+vdpa dev vstats show vdpa0 qidx 1
+.RS 4
+Shows vendor specific statistics information for vdpa device vdpa0 and virtqueue index 1
+.RE
 
 .SH SEE ALSO
 .BR vdpa (8),