diff mbox

libibverbs/doc: clarify selective signaling (Re: using IBV_SEND_SIGNALED)

Message ID 4CF4E65D.4070205@Voltaire.com (mailing list archive)
State Superseded, archived
Headers show

Commit Message

Or Gerlitz Nov. 30, 2010, 11:56 a.m. UTC
None
diff mbox

Patch

Index: libibverbs/man/ibv_post_send.3
===================================================================
--- libibverbs.orig/man/ibv_post_send.3
+++ libibverbs/man/ibv_post_send.3
@@ -112,6 +112,12 @@  request is fully executed and a work com
 from the corresponding completion queue (CQ). However, if the
 IBV_SEND_INLINE flag was set, the buffer can be reused immediately
 after the call returns.
+.PP
+Applications which use selective signaling should make sure to post
+a signaled WR (i.e one for which the IBV_SEND_SIGNALED flag is set) from
+time to time - depending on the requirements of the underlying rdma device.
+Typically the number of consecutive unsignaled WRs should not exceed the
+size of the send queue specified when the QP was created.
 .SH "SEE ALSO"
 .BR ibv_create_qp (3),
 .BR ibv_create_ah (3),