diff mbox series

[iproute2-next] Add description section to rdma man page

Message ID 20210124200026.75071-1-alanp@snowmoose.com
State New
Headers show
Series [iproute2-next] Add description section to rdma man page | expand

Commit Message

Alan Perry Jan. 24, 2021, 8 p.m. UTC
Add a description section with basic info about the rdma command for users
unfamiliar with it.

Signed-off-by: Alan Perry <alanp@snowmoose.com>
Acked-by: Leon Romanovsky <leonro@nvidia.com>

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

Comments

Leon Romanovsky Jan. 25, 2021, 6:25 a.m. UTC | #1
On Sun, Jan 24, 2021 at 12:00:27PM -0800, Alan Perry wrote:
> Add a description section with basic info about the rdma command for users

> unfamiliar with it.

>

> Signed-off-by: Alan Perry <alanp@snowmoose.com>

> Acked-by: Leon Romanovsky <leonro@nvidia.com>

>

> ---

>  man/man8/rdma.8 | 9 ++++++++-

>  1 file changed, 8 insertions(+), 1 deletion(-)


David, can you please pick it up?

Thanks
David Ahern Jan. 25, 2021, 4:50 p.m. UTC | #2
On 1/24/21 11:25 PM, Leon Romanovsky wrote:
> On Sun, Jan 24, 2021 at 12:00:27PM -0800, Alan Perry wrote:

>> Add a description section with basic info about the rdma command for users

>> unfamiliar with it.

>>

>> Signed-off-by: Alan Perry <alanp@snowmoose.com>

>> Acked-by: Leon Romanovsky <leonro@nvidia.com>

>>

>> ---

>>  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
diff mbox series

Patch

diff --git a/man/man8/rdma.8 b/man/man8/rdma.8
index c9e5d50d..66ef9902 100644
--- a/man/man8/rdma.8
+++ b/man/man8/rdma.8
@@ -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