From 93a276469bbee97e5a087d4754b88d2927613637 Mon Sep 17 00:00:00 2001 From: OFIWG Bot Date: Thu, 1 Oct 2015 09:36:11 -0700 Subject: [PATCH] Updated nroff-generated man pages --- man/man3/fi_atomic.3 | 4 +++- man/man3/fi_endpoint.3 | 7 +++++-- man/man3/fi_getinfo.3 | 7 ++++--- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/man/man3/fi_atomic.3 b/man/man3/fi_atomic.3 index 586d6d7609a..b428b36844d 100644 --- a/man/man3/fi_atomic.3 +++ b/man/man3/fi_atomic.3 @@ -1,4 +1,4 @@ -.TH fi_atomic 3 "2015\-09\-09" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@" +.TH fi_atomic 3 "2015\-10\-01" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@" .SH NAME .PP fi_atomic - Remote atomic functions @@ -94,6 +94,8 @@ operation .PP \f[I]count / compare_count / result_count\f[] : Count of vectored data entries. +The number of elements referenced, where each element is the indicated +datatype. .PP \f[I]addr\f[] : Address of remote memory to access. .PP diff --git a/man/man3/fi_endpoint.3 b/man/man3/fi_endpoint.3 index 4d5f0d05dc0..5749e8880d3 100644 --- a/man/man3/fi_endpoint.3 +++ b/man/man3/fi_endpoint.3 @@ -1,4 +1,4 @@ -.TH fi_endpoint 3 "2015\-07\-28" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@" +.TH fi_endpoint 3 "2015\-10\-01" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@" .SH NAME .PP fi_endpoint - Fabric endpoint operations @@ -408,7 +408,8 @@ canceled. If multiple outstanding operations match the context parameter, only one will be canceled. In this case, the operation which is canceled is provider specific. -The cancel operation will complete within a bounded period of time. +The cancel operation is asynchronous, but will complete within a bounded +period of time. .SS fi_alias .PP This call creates an alias to the specified endpoint. @@ -1232,6 +1233,8 @@ generate a completion event. .PP Returns 0 on success. On error, a negative value corresponding to fabric errno is returned. +For fi_cancel, a return value of 0 indicates that the cancel request was +submitted for processing. .PP Fabric errno values are defined in \f[C]rdma/fi_errno.h\f[]. .SH ERRORS diff --git a/man/man3/fi_getinfo.3 b/man/man3/fi_getinfo.3 index 4afc46fbdf6..84822bad7d7 100644 --- a/man/man3/fi_getinfo.3 +++ b/man/man3/fi_getinfo.3 @@ -1,4 +1,4 @@ -.TH fi_getinfo 3 "2015\-09\-23" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@" +.TH fi_getinfo 3 "2015\-10\-01" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@" .SH NAME .PP fi_getinfo / fi_freeinfo - Obtain / free fabric interface information @@ -460,8 +460,9 @@ However, when a large number of IOV entries are supported, IOV buffering may have a negative impact on performance and memory consumption. The FI_ASYNC_IOV mode indicates that the application must provide the buffering needed for the IO vectors. -When set, an application must not modify an IO vector until the -associated operation has completed. +When set, an application must not modify an IO vector, including any +related memory descriptor array, until the associated operation has +completed. .PP \f[I]FI_RX_CQ_DATA\f[] : This mode bit only applies to data transfers that set FI_REMOTE_CQ_DATA.