Skip to content

Commit

Permalink
man: Fix fi_rxm.7 and fi_collective.3 man pages
Browse files Browse the repository at this point in the history
fi_rxm.7: clarify the behavior when message size == FI_OFI_RXM_BUFFER_SIZE.

fi_collective.3: add the missing description of the `count` argument.

Signed-off-by: Jianxin Xiong <jianxin.xiong@intel.com>
  • Loading branch information
j-xiong committed Jan 8, 2024
1 parent 78771fb commit e570623
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 3 additions & 0 deletions man/fi_collective.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,9 @@ int fi_query_collective(struct fid_domain *domain,
*buf*
: Local data buffer that specifies first operand of collective operation
*count*
: The number of elements referenced, where each element is the indicated datatype.
*datatype*
: Datatype associated with atomic operands
Expand Down
4 changes: 2 additions & 2 deletions man/fi_rxm.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ FI_ORDER_SAW can not be supported.
The ofi_rxm provider checks for the following environment variables.

*FI_OFI_RXM_BUFFER_SIZE*
: Defines the transmit buffer size / inject size. Messages of size less than this
would be transmitted via an eager protocol and those above would be transmitted
: Defines the transmit buffer size / inject size. Messages of size less than or equal to this
would be transmitted via an eager protocol and messages greater in size would be transmitted
via a rendezvous or SAR (Segmentation And Reassembly) protocol. Transmit data
would be copied up to this size (default: ~16k).

Expand Down

0 comments on commit e570623

Please sign in to comment.