Skip to contentSkip to conversation

Add description section to rdma man page

PATCH In review Alan Perry 3 participants 3 messages Jan 24, 2021 – Jan 26, 2021

Subsystems (2)
lore
Share & tools
lore

Alan Perry

author
#0 lore raw

PATCH 1/1 Add description section to rdma man page

Add a description section with basic info about the rdma command for users unfamiliar with it.

---
 man/man8/rdma.8 | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
man/man8/rdma.8 +8 -1
index c9e5d50d..66ef9902 100644
@@ -1,4 +1,4 @@
-.TH RDMA 8 "28 Mar 2017" "iproute2" "Linux"
+.TH RDMA 8 "24 Jan 2021" "iproute2" "Linux"
 .SH NAME
 rdma \- RDMA tool
 .SH SYNOPSIS
@@ -29,6 +29,13 @@ rdma \- RDMA tool
 \fB\-j\fR[\fIson\fR] }
 \fB\-p\fR[\fIretty\fR] }
 
+.SH DESCRIPTION
+.B rdma
+is a tool for querying and setting the configuration for RDMA-capable
+devices. Remote direct memory access (RDMA) is the ability of accessing
+(reading, writing) memory on a remote machine without interrupting the
+processing of the CPU(s) on that system.
+
 .SH OPTIONS
 
 .TP
Signature · 1 line
2.30.0
#2 lore raw
Quoted 7 lines · Leon Romanovsky
Quoted 6 lines · Alan Perry

Add a description section with basic info about the rdma command for users unfamiliar with it.

Quoted 8 lines
Quoted 3 lines
---
 man/man8/rdma.8 | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

David, can you please pick it up?

Thanks

changes to man pages for existing features go through main branch. redirecting to Stephen