public inbox for linux-rdma@vger.kernel.org
 help / color / mirror / Atom feed
From: Christoph Hellwig <hch-jcswGhMUV9g@public.gmane.org>
To: jgunthorpe-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org
Cc: linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Subject: [PATCH 7/9] move librdmacm documentation to Documentation/
Date: Mon, 19 Sep 2016 08:56:31 -0700	[thread overview]
Message-ID: <1474300593-31922-8-git-send-email-hch@lst.de> (raw)
In-Reply-To: <1474300593-31922-1-git-send-email-hch-jcswGhMUV9g@public.gmane.org>

And drop bits that are outdated or replaced by top-level Documentation.

Signed-off-by: Christoph Hellwig <hch-jcswGhMUV9g@public.gmane.org>
---
 Documentation/librdmacm.md | 46 ++++++++++++++++++++++++++++++++++
 librdmacm/README           | 61 ----------------------------------------------
 2 files changed, 46 insertions(+), 61 deletions(-)
 create mode 100644 Documentation/librdmacm.md
 delete mode 100644 librdmacm/README

diff --git a/Documentation/librdmacm.md b/Documentation/librdmacm.md
new file mode 100644
index 0000000..5eb8d31
--- /dev/null
+++ b/Documentation/librdmacm.md
@@ -0,0 +1,46 @@
+# Device files
+
+The userspace CMA uses a single device file regardless of the number
+of adapters or ports present.
+
+To create the appropriate character device file automatically with
+udev, a rule like
+
+    KERNEL="rdma_cm", NAME="infiniband/%k", MODE="0666"
+
+can be used.  This will create the device node named
+
+    /dev/infiniband/rdma_cm
+
+or you can create it manually
+
+  mknod /dev/infiniband/rdma_cm c 231 255
+
+
+# Common issues
+
+Using multiple interfaces
+	The librdmacm does support multiple interfaces.  To make use
+	of multiple interfaces, however, you need to instruct linux
+	to only send ARP reples on the interface targetted in the ARP
+	request.  This can be done using a command similar to the
+	following:
+
+	sysctl -w net.ipv4.conf.all.arp_ignore=2
+
+	Without this change, it's possible for linux to resopnd to ARP
+	requests on a different interface (IP address) than the IP
+	address carried in the ARP request.  This causes the RDMA stack
+	to incorrectly map the remote IP address to the wrong RDMA
+	device.
+
+Using loopback
+	The librdmacm relies on ARP to resolve IP address to RDMA
+	addresses.  To support loopback connections between different
+	ports on the same system, ARP must be enabled for local
+	resolution:
+
+	sysctl net.ipv4.conf.all.accept_local=1
+
+	Without this setting, loopback connections may timeout
+	during address resolution.
diff --git a/librdmacm/README b/librdmacm/README
deleted file mode 100644
index e1f2227..0000000
--- a/librdmacm/README
+++ /dev/null
@@ -1,61 +0,0 @@
-This README is for userspace RDMA cm library.
-
-
-Building
-========
-To make this directory, run:
-./autogen.sh && ./configure && make && make install
-
-Typically the autogen and configure steps only need be done the first
-time unless configure.in or Makefile.am changes.
-
-Libraries are installed by default at /usr/local/lib.
-
-
-Device files
-============
-The userspace CMA uses a single device file regardless of the number
-of adapters or ports present.
-
-To create the appropriate character device file automatically with
-udev, a rule like
-
-    KERNEL="rdma_cm", NAME="infiniband/%k", MODE="0666"
-
-can be used.  This will create the device node named
-
-    /dev/infiniband/rdma_cm
-
-or you can create it manually
-
-  mknod /dev/infiniband/rdma_cm c 231 255
-
-
-Common issues
-=============
-
-Using multiple interfaces
-	The librdmacm does support multiple interfaces.  To make use
-	of multiple interfaces, however, you need to instruct linux
-	to only send ARP reples on the interface targetted in the ARP
-	request.  This can be done using a command similar to the
-	following:
-
-	sysctl -w net.ipv4.conf.all.arp_ignore=2
-
-	Without this change, it's possible for linux to resopnd to ARP
-	requests on a different interface (IP address) than the IP
-	address carried in the ARP request.  This causes the RDMA stack
-	to incorrectly map the remote IP address to the wrong RDMA
-	device.
-
-Using loopback
-	The librdmacm relies on ARP to resolve IP address to RDMA
-	addresses.  To support loopback connections between different
-	ports on the same system, ARP must be enabled for local
-	resolution:
-
-	sysctl net.ipv4.conf.all.accept_local=1
-
-	Without this setting, loopback connections may timeout
-	during address resolution.
-- 
2.1.4

--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

  parent reply	other threads:[~2016-09-19 15:56 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-19 15:56 update rdma-plumbing Documentation Christoph Hellwig
     [not found] ` <1474300593-31922-1-git-send-email-hch-jcswGhMUV9g@public.gmane.org>
2016-09-19 15:56   ` [PATCH 1/9] add reporting bugs and submitting patches sections to README.md Christoph Hellwig
2016-09-19 15:56   ` [PATCH 2/9] remove empty documentation files Christoph Hellwig
2016-09-19 15:56   ` [PATCH 3/9] remove README files in the provider directories Christoph Hellwig
2016-09-19 15:56   ` [PATCH 4/9] move rxe documentation to Documentation/ Christoph Hellwig
2016-09-19 15:56   ` [PATCH 5/9] move libibverbs " Christoph Hellwig
     [not found]     ` <1474300593-31922-6-git-send-email-hch-jcswGhMUV9g@public.gmane.org>
2016-09-19 17:02       ` Parav Pandit
2016-09-19 15:56   ` [PATCH 6/9] move libibcm " Christoph Hellwig
2016-09-19 15:56   ` Christoph Hellwig [this message]
2016-09-19 15:56   ` [PATCH 8/9] move srp_daemon " Christoph Hellwig
2016-09-19 15:56   ` [PATCH 9/9] remove iwpmd/README Christoph Hellwig
2016-09-19 19:25   ` update rdma-plumbing Documentation Jason Gunthorpe
     [not found]     ` <20160919192550.GA7486-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-09-19 20:59       ` Christoph Hellwig

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=1474300593-31922-8-git-send-email-hch@lst.de \
    --to=hch-jcswghmuv9g@public.gmane.org \
    --cc=jgunthorpe-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org \
    --cc=linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.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