netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Alan Perry <alanp@snowmoose.com>
To: netdev@vger.kernel.org
Cc: Alan Perry <alanp@snowmoose.com>, Leon Romanovsky <leonro@nvidia.com>
Subject: [PATCH iproute2-next] Add description section to rdma man page
Date: Sun, 24 Jan 2021 12:00:27 -0800	[thread overview]
Message-ID: <20210124200026.75071-1-alanp@snowmoose.com> (raw)

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(-)

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
-- 
2.30.0


             reply	other threads:[~2021-01-24 20:02 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-24 20:00 Alan Perry [this message]
2021-01-25  6:25 ` [PATCH iproute2-next] Add description section to rdma man page Leon Romanovsky
2021-01-25 16:50   ` David Ahern

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210124200026.75071-1-alanp@snowmoose.com \
    --to=alanp@snowmoose.com \
    --cc=leonro@nvidia.com \
    --cc=netdev@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).