Skip to content

Commit

Permalink
Merge pull request #3033 from shefty/docs
Browse files Browse the repository at this point in the history
Minor clarifications to man pages
  • Loading branch information
shefty authored Jun 6, 2017
2 parents aea4778 + a252981 commit c0fdc88
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
7 changes: 6 additions & 1 deletion man/fi_mr.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,12 @@ struct fi_mr_attr (defined below).
Fi_close is used to release all resources associated with a
registering a memory region. Once unregistered, further access to the
registered memory is not guaranteed.
registered memory is not guaranteed. Active or queued operations that
reference a memory region being closed may fail or result in accesses
to invalid memory. Applications are responsible for ensuring that a
MR is no longer needed prior to closing it. Note that accesses to a
closed MR from a remote peer will result in an error at the peer. The
state of the local endpoint will be unaffected.
When closing the MR, there must be no opened endpoints or counters associated
with the MR. If resources are still associated with the MR when attempting to
Expand Down
9 changes: 7 additions & 2 deletions man/fi_msg.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,9 +248,14 @@ fi_sendmsg.
posted receive operation to generate multiple events as messages are
placed into the buffer. The placement of received data into the
buffer may be subjected to provider specific alignment restrictions.

The buffer will be released by the provider when the available buffer
space falls below the specified minimum (see
FI_OPT_MIN_MULTI_RECV).
space falls below the specified minimum (see FI_OPT_MIN_MULTI_RECV).
Note that an entry to the associated receive completion queue will
always be generated when the buffer has been consumed, even if other
receive completions have been suppressed (i.e. the Rx context has been
configured for FI_SELECTIVE_COMPLETION). See the FI_MULTI_RECV
completion flag [`fi_cq`(3)](fi_cq.3.html).

*FI_INJECT_COMPLETE*
: Applies to fi_sendmsg. Indicates that a completion should be
Expand Down

0 comments on commit c0fdc88

Please sign in to comment.