[ewg] [PATCH 1/2] libibverbs/man: minor fixes to be consistent with libibverbs
Dotan Barak
dotanb at dev.mellanox.co.il
Mon Feb 25 05:48:10 PST 2008
Fix minor issues to be consistent with the libibverbs trunk.
Signed-off-by: Dotan Barak <dotanb at dev.mellanox.co.il>
---
diff --git a/man/ibv_get_cq_event.3 b/man/ibv_get_cq_event.3
index 430ffd0..27dca6f 100644
--- a/man/ibv_get_cq_event.3
+++ b/man/ibv_get_cq_event.3
@@ -20,9 +20,9 @@ waits for the next completion event in the completion event channel
.I channel\fR.
Fills the arguments
.I cq
-with the CQ that got the event and
+with the CQ that got the event and
.I cq_context
-with it's context\fR.
+with the CQ's context\fR.
.PP
.B ibv_ack_cq_events()
acknowledges
diff --git a/man/ibv_post_recv.3 b/man/ibv_post_recv.3
index 8efa9d3..46a630b 100644
--- a/man/ibv_post_recv.3
+++ b/man/ibv_post_recv.3
@@ -60,8 +60,12 @@ and not
.B ibv_post_recv()\fR,
since the QP's own receive queue will not be used.
.PP
-If a WR is being posted to a UD QP, the Global Routing Header (GRH) will be placed
-in the first 40 bytes of the buffer (whether or not GRH is actually being used by the QP).
+If a WR is being posted to a UD QP, the Global Routing Header (GRH) of
+the incoming message will be placed in the first 40 bytes of the
+buffer(s) in the scatter list. If no GRH is present in the incoming
+message, then the first bytes will be undefined. This means that in
+all cases, the actual data of the incoming message will start at an
+offset of 40 bytes into the buffer(s) in the scatter list.
.SH "SEE ALSO"
.BR ibv_create_qp (3),
.BR ibv_post_send (3),
diff --git a/man/ibv_post_srq_recv.3 b/man/ibv_post_srq_recv.3
index 2663a6d..65877cd 100644
--- a/man/ibv_post_srq_recv.3
+++ b/man/ibv_post_srq_recv.3
@@ -52,8 +52,12 @@ The buffers used by a WR can only be safely reused after WR the
request is fully executed and a work completion has been retrieved
from the corresponding completion queue (CQ).
.PP
-If a WR is being consumed by a UD QP, the Global Routing Header (GRH) will be placed
-in the first 40 bytes of the buffer (whether or not GRH is actually being used by the QP).
+If a WR is being posted to a UD QP, the Global Routing Header (GRH) of
+the incoming message will be placed in the first 40 bytes of the
+buffer(s) in the scatter list. If no GRH is present in the incoming
+message, then the first bytes will be undefined. This means that in
+all cases, the actual data of the incoming message will start at an
+offset of 40 bytes into the buffer(s) in the scatter list.
.SH "SEE ALSO"
.BR ibv_create_qp (3),
.BR ibv_post_send (3),
diff --git a/man/ibv_query_pkey.3 b/man/ibv_query_pkey.3
index f6d37c9..fcdfe6c 100644
--- a/man/ibv_query_pkey.3
+++ b/man/ibv_query_pkey.3
@@ -22,7 +22,7 @@ through the pointer
.I pkey\fR.
.SH "RETURN VALUE"
.B ibv_query_pkey()
-returns 0 on success, and -1 on error.
+returns 0 on success, and \-1 on error.
.SH "SEE ALSO"
.BR ibv_open_device (3),
.BR ibv_query_device (3),
More information about the ewg
mailing list