[Pkg-ofed-commits] [libfabric] 68/123: Updated nroff-generated man pages

[Ana Beatriz Guerrero López]

This is an automated email from the git hooks/post-receive script.

ana pushed a commit to annotated tag v1.1.1
in repository libfabric.

commit 0676d7ebe08941d8a56bef86acc53cff99e0aab5
Author: OFIWG Bot <ofiwg at lists.openfabrics.org>
Date:   Wed Sep 16 09:36:07 2015 -0700

    Updated nroff-generated man pages
---
 man/man3/fi_tagged.3 | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/man/man3/fi_tagged.3 b/man/man3/fi_tagged.3
index 3c6ca1b..69209ce 100644
--- a/man/man3/fi_tagged.3
+++ b/man/man3/fi_tagged.3
@@ -1,4 +1,4 @@
-.TH fi_tagged 3 "2015\-09\-09" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@"
+.TH fi_tagged 3 "2015\-09\-16" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@"
 .SH NAME
 .PP
 fi_tagged - Tagged data transfer operations
@@ -258,10 +258,14 @@ message has arrived.
 A peek request is often useful on endpoints that have provider allocated
 buffering enabled (see fi_rx_attr total_buffered_recv).
 Unlike standard receive operations, a receive operation with the FI_PEEK
-flag set does not remain queued with the provider until the peek
+flag set does not remain queued with the provider after the peek
 completes successfully.
-If no data is available, the FI_PEEK receive will complete with a status
-of FI_ENOMSG.
+The peek operation operates asynchronously, and the results of the peek
+operation are available in the completion queue associated with the
+endpoint.
+If no message is found matching the tags specified in the peek request,
+then a completion queue error entry with err field set to FI_ENOMSG will
+be available.
 .PP
 If a peek request locates a matching message, the operation will
 complete successfully.
@@ -271,8 +275,12 @@ data, tag, and source address.
 The data available is subject to the completion entry format (e.g.
 struct fi_cq_tagged_entry).
 .PP
-An application may supply a buffer as part of the peek operation.
-If given, the provider may return a copy of the message data.
+An application may supply a buffer if it desires to receive data as a
+part of the peek operation.
+In order to receive data as a part of the peek operation, the buf and
+len fields must be available in the CQ format.
+In particular, FI_CQ_FORMAT_CONTEXT and FI_CQ_FORMAT_MSG cannot be used
+if peek operations desire to obtain a copy of the data.
 The returned data is limited to the size of the input buffer(s) or the
 message size, if smaller.
 A provider indicates if data is available by setting the buf field of

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ofed/libfabric.git