Skip to content

Commit

Permalink
Merge pull request ofiwg#8277 from ofiwg/pr/update-nroff-generated-ma…
Browse files Browse the repository at this point in the history
…n-pages-main

Update nroff-generated man pages
  • Loading branch information
github-actions[bot] authored Nov 29, 2022
2 parents b2b43b0 + 6d06af5 commit abdfa50
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions man/man3/fi_peer.3
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.5
.\"
.TH "fi_peer" "3" "2022\-11\-04" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.TH "fi_peer" "3" "2022\-11\-29" "Libfabric Programmer\[cq]s Manual" "#VERSION#"
.hy
.SH NAME
.TP
Expand Down Expand Up @@ -607,12 +607,11 @@ struct fi_peer_transfer_context {
.PP
Peer transfer contexts form a virtual link between endpoints allocated
on each of the peer providers.
The setup of a peer transfer context occurs through the fi_endpoint2()
The setup of a peer transfer context occurs through the fi_endpoint()
API.
The main provider calls fi_endpoint2() passing in the FI_PEER_TRANSFER
flag.
When specified, the context parameter reference the struct
fi_peer_transfer_context defined above.
The main provider calls fi_endpoint() with the FI_PEER_TRANSFER mode bit
set in the info parameter, and the context parameter must reference the
struct fi_peer_transfer_context defined above.
.PP
The size field indicates the size of struct fi_peer_transfer_context
being passed to the peer.
Expand All @@ -623,13 +622,13 @@ It may be used to report the capabilities and restrictions on peer
transfers, such as whether memory registration is required, maximum
message sizes, data and completion ordering semantics, and so forth.
If the importing provider cannot meet these restrictions, it must fail
the fi_endpoint2() call.
the fi_endpoint() call.
.PP
The peer_ops field contains callbacks from the main provider into the
peer and is used to report the completion (success or failure) of peer
initiated data transfers.
The callback functions defined in struct fi_ops_transfer_peer must be
set by the peer provider before returning from the fi_endpoint2() call.
set by the peer provider before returning from the fi_endpoint() call.
Actions that the peer provider can take from within the completion
callbacks are most unrestricted, and can include any of the following
types of operations: initiation of additional data transfers, writing
Expand Down

0 comments on commit abdfa50

Please sign in to comment.