From ec3911dbb251db9b32508b06c5203df04d0b60bb Mon Sep 17 00:00:00 2001 From: Shi Jin Date: Wed, 15 Jan 2025 16:36:25 +0000 Subject: [PATCH] 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 --- man/fi_endpoint.3.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/man/fi_endpoint.3.md b/man/fi_endpoint.3.md index dfb51d69d00..e74049c2857 100644 --- a/man/fi_endpoint.3.md +++ b/man/fi_endpoint.3.md @@ -537,7 +537,8 @@ The following option levels and option names and parameters are defined. All providers that support FI_HMEM capability implement this option. - *FI_OPT_SHARED_MEMORY_PERMITTED - bool* -: This option controls the use of shared memory for intra-node communication. +: This option only applies to the fi_setopt call. + This option controls the use of shared memory for intra-node communication. Setting it to true will allow the use of shared memory. When set to false, shared memory will not be used and the implementation of intra-node communication is provider dependent.