netdev - Re: [PATCH] rdma.8: Add basic description for users unfamiliar with rdma

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 23 Dec 2020 22:23:34 -0800
From:   Alan Perry <alanp@...wmoose.com>
To:     Leon Romanovsky <leonro@...dia.com>
Cc:     netdev@...r.kernel.org
Subject: Re: [PATCH] rdma.8: Add basic description for users unfamiliar with
 rdma



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 <alanp@...wmoose.com>
>> ---
>>   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 <leonro@...dia.com>
> 

That change looks good to me.

One other change that I wanted to make, but couldn't figure out how to 
do it without it in a manner wasn't awkward is to make it more clear in 
the rdma.8 man page that the other rdma man pages describe the rdma 
"object" variants. That wasn't immediately clear to me the first couple 
times that I read the rdma.8 page.

alan