Skip to content

Commit

Permalink
man/fi_mr: Fix typo
Browse files Browse the repository at this point in the history
FI_RAW_MR should be replaced to FI_MR_RAW

Signed-off-by: Shi Jin <sjina@amazon.com>
  • Loading branch information
shijin-aws committed May 1, 2024
1 parent 73d0519 commit 97d9832
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions man/fi_mr.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,7 @@ this call.
Returns the remote protection key associated with a MR. The memory
registration must have completed successfully before invoking this. The
returned key may be used in data transfer operations at a peer. If the
FI_RAW_MR mode bit has been set for the domain, then the memory key must
FI_MR_RAW mode bit has been set for the domain, then the memory key must
be obtained using the fi_mr_raw_key function instead. A return value of
FI_KEY_NOTAVAIL will be returned if the registration has not completed
or a raw memory key is required.
Expand All @@ -431,7 +431,7 @@ or a raw memory key is required.
Returns the raw, remote protection key and base address associated with a MR.
The memory registration must have completed successfully before invoking
this routine. Use of this call is required if the FI_RAW_MR mode bit has
this routine. Use of this call is required if the FI_MR_RAW mode bit has
been set by the provider; however, it is safe to use this call with any
memory region.
Expand All @@ -452,7 +452,7 @@ can be used for data transfer operations. The mapping is done by the
peer that initiates the RMA or atomic operation. The mapping function
takes as input the raw key and its size, and returns the mapped key.
Use of the fi_mr_map_raw function is required if the peer has the
FI_RAW_MR mode bit set, but this routine may be called on any valid
FI_MR_RAW mode bit set, but this routine may be called on any valid
key. All mapped keys must be freed by calling fi_mr_unmap_key when
access to the peer memory region is no longer necessary.
Expand Down Expand Up @@ -766,7 +766,7 @@ the memory region. The application is responsible for transferring this
key to the peer. If FI_MR_RAW mode has been set, the key must be retrieved
using the fi_mr_raw_attr function.

FI_RAW_MR allows support for providers that require more than 8-bytes for
FI_MR_RAW allows support for providers that require more than 8-bytes for
their protection keys or need additional setup before a key can
be used for transfers. After a raw key has been retrieved, it must be
exchanged with the remote peer. The peer must use fi_mr_map_raw to convert
Expand Down

0 comments on commit 97d9832

Please sign in to comment.