Skip to content

Commit 950fb1b

Browse files
committed
man/fi_endpoint: regulate the usage of optname
FI_OPT_SHARED_MEMORY_PERMITTED is used to enforce an endpoint to NOT use shm in the data transfer. It should only apply to the fi_setopt call, in the same model of FI_OPT_CUDA_API_PERMITTED. Signed-off-by: Shi Jin <[email protected]>
1 parent ca0758b commit 950fb1b

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

man/fi_endpoint.3.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,8 @@ The following option levels and option names and parameters are defined.
537537
All providers that support FI_HMEM capability implement this option.
538538
539539
- *FI_OPT_SHARED_MEMORY_PERMITTED - bool*
540-
: This option controls the use of shared memory for intra-node communication.
540+
: This option only applies to the fi_setopt call.
541+
This option controls the use of shared memory for intra-node communication.
541542
Setting it to true will allow the use of shared memory. When set to false,
542543
shared memory will not be used and the implementation of intra-node communication
543544
is provider dependent.

0 commit comments

Comments
 (0)