aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRoland Dreier <rolandd@cisco.com>2006-03-22 18:58:00 +0000
committerRoland Dreier <rolandd@cisco.com>2006-11-09 11:36:00 -0800
commit1ac5f02fc0278b1d192a762b0fad523dc9c41dcb (patch)
tree0e84b6655f3af6bd3765c78d5d04c56a6f9f57c3
parent02560ea7949aee05a8932bfd419337613622c2cb (diff)
downloadlibibverbs-1ac5f02fc0278b1d192a762b0fad523dc9c41dcb.tar.gz
Improve documentation of ibv_req_notify_cq()
Signed-off-by: Roland Dreier <rolandd@cisco.com>
-rw-r--r--ChangeLog5
-rw-r--r--include/infiniband/verbs.h8
2 files changed, 12 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index 2a4d01d..9091847 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-03-22 Roland Dreier <rdreier@cisco.com>
+
+ * include/infiniband/verbs.h (ibv_req_notify_cq): Document
+ parameters better.
+
2006-03-16 Roland Dreier <rdreier@cisco.com>
* src/cmd.c, src/device.c, src/memory.c, src/verbs.c: Add include
diff --git a/include/infiniband/verbs.h b/include/infiniband/verbs.h
index d51560d..ccea54c 100644
--- a/include/infiniband/verbs.h
+++ b/include/infiniband/verbs.h
@@ -795,7 +795,13 @@ static inline int ibv_poll_cq(struct ibv_cq *cq, int num_entries, struct ibv_wc
}
/**
- * ibv_req_notify_cq - Request completion notification on a CQ.
+ * ibv_req_notify_cq - Request completion notification on a CQ. An
+ * event will be added to the completion channel associated with the
+ * CQ when an entry is added to the CQ.
+ * @cq: The completion queue to request notification for.
+ * @solicited_only: If non-zero, an event will be generated only for
+ * the next solicited CQ entry. If zero, any CQ entry, solicited or
+ * not, will generate an event.
*/
static inline int ibv_req_notify_cq(struct ibv_cq *cq, int solicited_only)
{