Subject: [PATCH] librdmacm: document/clarify the delivery of connection

established event

Applications based on the rdma-cm may assume that established event
is always delivered by the the kernel stack, clarify that.

Signed-off-by: Or Gerlitz <ogerlitz@voltaire.com>

diff --git a/man/rdma_notify.3 b/man/rdma_notify.3
index 7114ac42346e88833bfbaff5b6007cd74ba6bebe..88420c29361530aa6bec3dc9611b18a67f3b223e 100644 (file)
--- a/man/rdma_notify.3
+++ b/man/rdma_notify.3
@@ -24,6 +24,8 @@ necessary, however if connection establishment is done out of band
 QP that is not yet considered connected.  This routine forces the
 connection into an established state in this case in order to handle
 the rare situation where the connection never forms on its own.
+Calling this routine ensures the delivery of the RDMA_CM_EVENT_ESTABLISHED
+event to the application.
 Events that should be reported to the CM are: IB_EVENT_COMM_EST.
 .SH "SEE ALSO"
 rdma_connect(3), rdma_accept(3), rdma_listen(3)