[v3,iproute2-next,3/3] rdma: Adjust man page for rdma system set privileged-qkey command

Commit Message

Patrisious Haddad Oct. 25, 2023, 12:31 p.m. UTC

Signed-off-by: Patrisious Haddad <[e-mail]>
Reviewed-by: Michael Guralnik <[e-mail]>
Reviewed-by: Petr Machata <[e-mail]>
---
 man/man8/rdma-system.8 | 32 +++++++++++++++++++++++++++++---
 1 file changed, 29 insertions(+), 3 deletions(-)

Patch

diff --git a/man/man8/rdma-system.8 b/man/man8/rdma-system.8
index ab1d89fd..554938eb 100644
--- a/man/man8/rdma-system.8
+++ b/man/man8/rdma-system.8
@@ -26,13 +26,20 @@  rdma-system \- RDMA subsystem configuration
 .BR netns
 .BR NEWMODE
 
+.ti -8
+.B rdma system set
+.BR privileged-qkey
+.BR NEWSTATE
+
 .ti -8
 .B rdma system help
 
 .SH "DESCRIPTION"
-.SS rdma system set - set RDMA subsystem network namespace mode
+.SS rdma system set - set RDMA subsystem network namespace mode or
+privileged qkey mode
 
-.SS rdma system show - display RDMA subsystem network namespace mode
+.SS rdma system show - display RDMA subsystem network namespace mode and
+privileged qkey state
 
 .PP
 .I "NEWMODE"
@@ -49,12 +56,18 @@  network namespaces is not needed, shared mode can be used.
 
 It is preferred to not change the subsystem mode when there is active
 RDMA traffic running, even though it is supported.
+.PP
+.I "NEWSTATE"
+- Specifies the new state of the privileged-qkey parameter, either on or off.
+This parameter determines whether a non-privileged user is allowed to specify a
+controlled QKEY or not.
 
 .SH "EXAMPLES"
 .PP
 rdma system show
 .RS 4
-Shows the state of RDMA subsystem network namespace mode on the system.
+Shows the state of RDMA subsystem network namespace mode on the system and
+the state of privileged qkey parameter.
 .RE
 .PP
 rdma system set netns exclusive
@@ -69,6 +82,19 @@  Sets the RDMA subsystem in network namespace shared mode. In this mode RDMA devi
 are shared among network namespaces.
 .RE
 .PP
+.PP
+rdma system set privileged-qkey on
+.RS 4
+Sets the privileged-qkey parameter to on. In this state non-privileged user
+is allowed to specify a controlled QKEY.
+.RE
+.PP
+rdma system set privileged-qkey off
+.RS 4
+Sets the privileged-qkey parameter to off. In this state non-privileged user
+is *not* allowed to specify a controlled QKEY.
+.RE
+.PP
 
 .SH SEE ALSO
 .BR rdma (8),