Subject: Re: [PATCH v2] rdma.8: Add basic description for users unfamiliar with rdma

From: Leon Romanovsky <[email-masked]>
Date: Sun, 24 Jan 2021 21:03:25 +0200

On Sun, Jan 24, 2021 at 10:09:55AM -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 <[email-masked]>
> ---
>   man/man8/rdma.8 | 9 ++++++++-
>   1 file changed, 8 insertion(+), 1 deletion(-)
> 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

Please send patch with git send-email and not as reply.
Also don't forget to add my Acked-by, use [PATCH iproute2-next] in the
title and add Changelog under "---".

Thanks

>
> On 1/23/21 10:31 PM, Leon Romanovsky wrote:
> > On Thu, Jan 21, 2021 at 01:32:42PM -0800, Alan Perry wrote:
> > >
> > > On 12/23/20 12:19 AM, Leon Romanovsky wrote:
> > > > On Tue, Dec 22, 2020 at 08:47:51PM -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 <[email-masked]>
> > > > > ---
> > > > >    man/man8/rdma.8 | 6 +++++-
> > > > >    1 file changed, 5 insertion(+), 1 deletion(-)
> > > > >
> > > > > diff --git a/man/man8/rdma.8 b/man/man8/rdma.8
> > > > > index c9e5d50d..d68d0cf6 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 "22 Dec 2020" "iproute2" "Linux"
> > > > >    .SH NAME
> > > > >    rdma \- RDMA tool
> > > > >    .SH SYNOPSIS
> > > > > @@ -29,6 +29,10 @@ 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, direct
> > > > > memory access between the memory of two computers without use of the
> > > > > operating system on either computer.
> > > > > +
> > > > Thanks, it is too close to the Wikipedia description that can be written
> > > > slightly differently (without "two computers"), what about the following
> > > > description from Mellanox site?
> > > >
> > > > "is a tool for querying and setting the configuration for RDMA-capable
> > > > devices. Remote direct memory access (RDMA) is the ability of accessing
> > > > (read, write) memory on a remote machine without interrupting the processing
> > > > of the CPU(s) on that system."
> > > >
> > > > Thanks,
> > > > Acked-by: Leon Romanovsky <[email-masked]>
> > > >
> > > I noticed that the rdma man page has not been changed. I am unfamiliar with
> > > the process. Should I have submitted an updated patch with the alternate
> > > wording after this exchange?
> > Yes, please.
> >
> > Thanks
> >
> > > alan