From: Or Gerlitz <ogerlitz@voltaire.com>
Date: Tue, 12 Sep 2006 16:03:33 +0000 (-0700)
Subject: RDMA/cma: Document rdma_destroy_id() function
X-Git-Tag: v2.6.19-rc1~1293^2~10
X-Git-Url: https://openfabrics.org/gitweb/?a=commitdiff_plain;h=07eeec0627e93a1a753c4df004a97a4d0a7b9ceb;p=~shefty%2Frdma-dev.git

RDMA/cma: Document rdma_destroy_id() function

Clarify that rdma_destroy_id cancels outstanding asynchronous operations on the
Associated id.

Signed-off-by: Or Gerlitz <ogerlitz@voltaire.com>
Signed-off-by: Sean Hefty <sean.hefty@intel.com>
Signed-off-by: Roland Dreier <rolandd@cisco.com>
---

diff --git a/include/rdma/rdma_cm.h b/include/rdma/rdma_cm.h
index 402c63d7226..1566be568ab 100644
--- a/include/rdma/rdma_cm.h
+++ b/include/rdma/rdma_cm.h
@@ -117,6 +117,14 @@ struct rdma_cm_id {
 struct rdma_cm_id *rdma_create_id(rdma_cm_event_handler event_handler,
 				  void *context, enum rdma_port_space ps);
 
+/**
+  * rdma_destroy_id - Destroys an RDMA identifier.
+  *
+  * @id: RDMA identifier.
+  *
+  * Note: calling this function has the effect of canceling in-flight
+  * asynchronous operations associated with the id.
+  */
 void rdma_destroy_id(struct rdma_cm_id *id);
 
 /**