From e813fe69c051cb271f4f58e009db216935ed1a96 Mon Sep 17 00:00:00 2001 From: OFIWG Bot Date: Thu, 30 Jan 2025 19:00:34 +0000 Subject: [PATCH] Updated nroff-generated man pages Signed-off-by: OFIWG Bot --- fabtests/man/man7/fabtests.7 | 4 ++-- man/man3/fi_domain.3 | 6 +----- man/man3/fi_endpoint.3 | 3 ++- man/man7/fi_efa.7 | 7 +++++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/fabtests/man/man7/fabtests.7 b/fabtests/man/man7/fabtests.7 index acc82feb924..fdb4dadecb7 100644 --- a/fabtests/man/man7/fabtests.7 +++ b/fabtests/man/man7/fabtests.7 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "fabtests" "7" "2024\-12\-10" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fabtests" "7" "2025\-01\-30" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -364,7 +364,7 @@ FI_RMA, FI_MSG, FI_SEND, FI_RECV, FI_READ, FI_WRITE, FI_REMOTE_READ, FI_REMOTE_WRITE, FI_TAGGED, FI_DIRECTED_RECV .TP \f[I]mode - values OR\[cq]ed together\f[R] -FI_CONTEXT, FI_RX_CQ_DATA +FI_CONTEXT, FI_CONTEXT2, FI_RX_CQ_DATA .TP \f[I]ep_type\f[R] FI_EP_MSG, FI_EP_DGRAM, FI_EP_RDM diff --git a/man/man3/fi_domain.3 b/man/man3/fi_domain.3 index be3d6c8af5d..5306dfe98f4 100644 --- a/man/man3/fi_domain.3 +++ b/man/man3/fi_domain.3 @@ -15,7 +15,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "fi_domain" "3" "2024\-12\-10" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_domain" "3" "2025\-01\-30" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -186,10 +186,6 @@ registration operations asynchronously, with the completion reported through the event queue. If an event queue is not bound to the domain with the FI_REG_MR flag, then memory registration requests complete synchronously. -.PP -See \f[V]fi_av_bind\f[R](3), \f[V]fi_ep_bind\f[R](3), -\f[V]fi_mr_bind\f[R](3), \f[V]fi_pep_bind\f[R](3), and -\f[V]fi_scalable_ep_bind\f[R](3) for more information. .SS fi_close .PP The fi_close call is used to release all resources associated with a diff --git a/man/man3/fi_endpoint.3 b/man/man3/fi_endpoint.3 index f03197d02b2..0adf7f4d155 100644 --- a/man/man3/fi_endpoint.3 +++ b/man/man3/fi_endpoint.3 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "fi_endpoint" "3" "2024\-12\-10" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_endpoint" "3" "2025\-01\-30" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -610,6 +610,7 @@ All providers that support FI_HMEM capability implement this option. \[bu] .RS 2 .TP \f[I]FI_OPT_SHARED_MEMORY_PERMITTED - bool\f[R] +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. diff --git a/man/man7/fi_efa.7 b/man/man7/fi_efa.7 index 6d6f780b3c7..eaac5348d71 100644 --- a/man/man7/fi_efa.7 +++ b/man/man7/fi_efa.7 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "fi_efa" "7" "2025\-01\-13" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_efa" "7" "2025\-01\-30" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -111,7 +111,7 @@ No support for selective completions. No support for counters for the DGRAM endpoint. .PP No support for inject. -.SS zero-copy receive mode +.SS Zero-copy receive mode .IP \[bu] 2 The receive operation cannot be cancelled via \f[V]fi_cancel()\f[R]. .IP \[bu] 2 @@ -144,6 +144,7 @@ if these operations are assisted by hardware support (return value is false). .TP \f[I]FI_OPT_EFA_USE_DEVICE_RDMA - bool\f[R] +These option only applies to the fi_setopt() call. Only available if the application selects a libfabric API version >= 1.18. This option allows an application to change libfabric\[cq]s behavior @@ -164,6 +165,7 @@ For API<1.18, RDMA is enabled by default only on certain newer hardware revisions. .TP \f[I]FI_OPT_EFA_SENDRECV_IN_ORDER_ALIGNED_128_BYTES - bool\f[R] +These option only applies to the fi_setopt() call. It is used to force the endpoint to use in-order send/recv operation for each 128 bytes aligned block. Enabling the option will guarantee data inside each 128 bytes aligned @@ -173,6 +175,7 @@ If endpoint is not able to support this feature, it will return -FI_EOPNOTSUPP for the call to fi_setopt(). .TP \f[I]FI_OPT_EFA_WRITE_IN_ORDER_ALIGNED_128_BYTES - bool\f[R] +These option only applies to the fi_setopt() call.. It is used to set the endpoint to use in-order RDMA write operation for each 128 bytes aligned block. Enabling the option will guarantee data inside each 128 bytes aligned