librdmacm/man: more updates to man pages

Updates to rdma_disconnect, rdma_join_multicast, and return codes.

Signed-off-by: Sean Hefty <sean.hefty@intel.com>

diff --git a/man/rdma_cm.7 b/man/rdma_cm.7
index f2e1319ed338f9eedf519d708d9a6f3a306600f6..23571b28b6a143ac04e0c80f5a4a007b2dfce6ce 100644 (file)
--- a/man/rdma_cm.7
+++ b/man/rdma_cm.7
@@ -1,4 +1,4 @@
-.TH "RDMA_CM" 7 "2007-08-06" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
+.TH "RDMA_CM" 7 "2008-01-02" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
 .SH NAME
 rdma_cm \- RDMA communication manager.
 .SH SYNOPSIS
@@ -103,6 +103,23 @@ release the connected rdma_cm_id
 release the listening rdma_cm_id
 .IP rdma_destroy_event_channel
 release the event channel
+.SH "RETURN CODES"
+.IP "=  0"
+success
+.IP "= -1"
+error - see errno for more details
+.IP "< -1"
+error - see include/asm-generic/errno*.h for more details
+.P
+Librdmacm functions return 0 to indicate success, and a negative return value
+to indicate failure.  If a function operates asynchronously, a return value of 0
+means that the operation was successfully started.  The operation could still
+complete in error; users should check the status of the related event.  If the
+return value is -1, then errno can be examined for additional information
+regarding the reason for the failure.  If the return value is < -1, then
+additional error reasons can be obtained by comparing the returned value with
+the values listed in include/asm-generic/errno-base.h and
+include/asm-generic/errno.h.
 .SH "SEE ALSO"
 rdma_create_event_channel(3), rdma_get_cm_event(3), rdma_create_id(3),
 rdma_resolve_addr(3), rdma_bind_addr(3), rdma_create_qp(3),

diff --git a/man/rdma_disconnect.3 b/man/rdma_disconnect.3
index 10d98e5abeee93a217740288754c5101f712df74..8b2a03500d396d528b2b0a72a4c4ee19949d2d77 100644 (file)
--- a/man/rdma_disconnect.3
+++ b/man/rdma_disconnect.3
@@ -1,4 +1,4 @@
-.TH "RDMA_DISCONNECT" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
+.TH "RDMA_DISCONNECT" 3 "2008-01-02" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
 .SH NAME
 rdma_disconnect \- This function disconnects a connection.
 .SH SYNOPSIS
@@ -10,7 +10,10 @@ rdma_disconnect \- This function disconnects a connection.
 .IP "id" 12
 RDMA identifier.
 .SH "DESCRIPTION"
-Disconnects a connection and transitions any associated QP to the error state.
-This routing may be called by both the client and server side of a connection.
+Disconnects a connection and transitions any associated QP to the error state,
+which will flush any posted work requests to the completion queue.  This
+routine may be called by both the client and server side of a connection.
+After successfully disconnecting, an RDMA_CM_EVENT_DISCONNECTED event will be
+generated on both sides of the connection.
 .SH "SEE ALSO"
-rdma_connect(3), rdma_listen(3), rdma_accept(3)
+rdma_connect(3), rdma_listen(3), rdma_accept(3), rdma_get_cm_event(3)

diff --git a/man/rdma_join_multicast.3 b/man/rdma_join_multicast.3
index 9acfd68ffd3533fea9e73debc0c4f821ca73ad8e..2df57a03b9def43d131b5320d04456936ac0461a 100644 (file)
--- a/man/rdma_join_multicast.3
+++ b/man/rdma_join_multicast.3
@@ -1,4 +1,4 @@
-.TH "RDMA_JOIN_MULTICAST" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
+.TH "RDMA_JOIN_MULTICAST" 3 "2008-01-02" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
 .SH NAME
 rdma_join_multicast \- Joins a multicast group.
 .SH SYNOPSIS
@@ -21,9 +21,12 @@ Joins a multicast group and attaches an associated QP to the group.
 Before joining a multicast group, the rdma_cm_id must be bound to
 an RDMA device by calling rdma_bind_addr or rdma_resolve_addr.  Use of
 rdma_resolve_addr requires the local routing tables to resolve the
-multicast address to an RDMA device.  The user must call
-rdma_leave_multicast to leave the multicast group and release any
-multicast resources.  The context is returned to the user through
+multicast address to an RDMA device, unless a specific source address
+is provided.  The user must call rdma_leave_multicast to leave the
+multicast group and release any multicast resources.  After the join
+operation completes, any associated QP is automatically attached to the
+multicast group, and the join context is returned to the user through
 the private_data field in the rdma_cm_event.
 .SH "SEE ALSO"
-rdma_leave_multicast(3), rdma_bind_addr(3), rdma_resolve_addr(3), rdma_create_qp(3)
+rdma_leave_multicast(3), rdma_bind_addr(3), rdma_resolve_addr(3), rdma_create_qp(3),
+rdma_get_cm_event(3)