From: Sean Hefty Date: Thu, 14 Jun 2012 15:56:06 +0000 (-0700) Subject: commit X-Git-Url: https://openfabrics.org/gitweb/?a=commitdiff_plain;h=363d8de9639c1f7da72670fb0cd69df3dc3b58f7;p=~shefty%2Flibrdmacm.git commit --- diff --git a/meta b/meta index fb74e15f..1e4a4f01 100644 --- a/meta +++ b/meta @@ -1,8 +1,7 @@ Version: 1 -Previous: 877c467dd4f9e617d2de124052c4b380c6e9aa5f +Previous: 84410c3dfc13dec6c939765fec6c260ccfbe2a8d Head: 36dbcc6dd62fc62a0bb8bc3cc82869eb4242fd4f Applied: - rs-man: dba7b4833fd1208813028483451d389cbeecf02a v6only: 36dbcc6dd62fc62a0bb8bc3cc82869eb4242fd4f Unapplied: rs-1sge: 8ec392829399dec7ed5c608b8697a482e5faa2de diff --git a/patches/rs-man b/patches/rs-man deleted file mode 100644 index c169fc5e..00000000 --- a/patches/rs-man +++ /dev/null @@ -1,114 +0,0 @@ -Bottom: 19653040b4f6827e46b2b5079ab41e32a223fc76 -Top: b2be28c058bcea1f57039dd4966c64ac692e6bfa -Author: Sean Hefty -Date: 2012-06-11 13:20:18 -0700 - -rsocket: Add rsocket man page - -Signed-off-by: Sean Hefty - - ---- - -diff --git a/Makefile.am b/Makefile.am -index 1dc61e1..51b2f89 100644 ---- a/Makefile.am -+++ b/Makefile.am -@@ -113,7 +113,8 @@ man_MANS = \ - man/rdma_xclient.1 \ - man/rstream.1 \ - man/rcopy.1 \ -- man/rdma_cm.7 -+ man/rdma_cm.7 \ -+ man/rsocket.7 - - EXTRA_DIST = src/cma.h src/indexer.h src/librdmacm.map \ - librdmacm.spec.in $(man_MANS) -diff --git a/man/rsocket.7 b/man/rsocket.7 -new file mode 100644 -index 0000000..c6a2ad1 ---- /dev/null -+++ b/man/rsocket.7 -@@ -0,0 +1,82 @@ -+.TH "RSOCKET" 7 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm -+.SH NAME -+rsocket \- RDMA socket API -+.SH SYNOPSIS -+.B "#include " -+.SH "DESCRIPTION" -+RDMA socket API and protocol -+.SH "NOTES" -+rsockets is a protocol over RDMA that supports a socket-level API -+for applications. rsocket APIs are intended to match the behavior -+of corresponding socket calls, except where noted. rsocket -+functions match the name and function signature of socket calls, -+with the exception that all function calls are prefixed with an 'r'. -+.P -+The following functions are defined: -+.P -+rsocket -+.P -+rbind, rlisten, raccept, rconnect -+.P -+rshutdown, rclose -+.P -+rrecv, rrecvfrom, rrecvmsg, rread, rreadv -+.P -+rsend, rsendto, rsendmsg, rwrite, rwritev -+.P -+rpoll, rselect -+.P -+rgetpeername, rgetsockname -+.P -+rsetsockopt, rgetsockopt, rfcntl -+.P -+Functions take the same parameters as that use for sockets. The -+follow capabilities and flags are supported at this time: -+.P -+PF_INET, PF_INET6, SOCK_STREAM, IPPROTO_TCP, TCP_MAXSEG -+.P -+MSG_DONTWAIT, MSG_PEEK -+.P -+SO_REUSEADDR, TCP_NODELAY, SO_ERROR, SO_SNDBUF, SO_RCVBUF -+.P -+O_NONBLOCK -+.P -+In addition to standard socket options, rsockets supports options -+specific to RDMA devices and protocols. These options are accessible -+through rsetsockopt using SOL_RDMA option level. -+.TP -+RDMA_SQSIZE - Integer size of the underlying send queue. -+.TP -+RDMA_RQSIZE - Integer size of the underlying receive queue. -+.TP -+RDMA_INLINE - Integer size of inline data. -+.P -+Note that rsockets fd's cannot be passed into non-rsocket calls. For -+applications which must mix rsocket fd's with standard socket fd's or -+opened files, rpoll and rselect support polling both rsockets and -+normal fd's. -+.P -+Existing applications can make use of rsockets through the use of a -+preload library. Because rsockets implements an end-to-end protocol, -+both sides of a connection must use rsockets. The rdma_cm library -+provides such a preload library. See the librdmacm documentation for -+more details. -+.P -+rsockets uses configuration files that give an administrator control -+over the default settings used by rsockets. Use files under -+%sysconfig%/rdma/rsocket as shown: -+.P -+.P -+mem_default - default size of receive buffer(s) -+.P -+wmem_default - default size of send buffer(s) -+.P -+sqsize_default - default size of send queue -+.P -+rqsize_default - default size of receive queue -+.P -+inline_default - default size of inline data -+.P -+If configuration files are not available, rsockets uses internal defaults. -+.SH "SEE ALSO" -+rdma_cm(7)