From 0e7af5a2448ad835bf86825de40354ebbcd0ad93 Mon Sep 17 00:00:00 2001 From: OFIWG Bot Date: Fri, 23 Aug 2024 16:48:43 +0000 Subject: [PATCH] Updated nroff-generated man pages Signed-off-by: OFIWG Bot --- man/man3/fi_domain.3 | 10 +++++----- man/man3/fi_endpoint.3 | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/man/man3/fi_domain.3 b/man/man3/fi_domain.3 index bc0f9dad055..4b85a4d0d45 100644 --- a/man/man3/fi_domain.3 +++ b/man/man3/fi_domain.3 @@ -1,7 +1,7 @@ .\"t .\" Automatically generated by Pandoc 2.9.2.1 .\" -.TH "fi_domain" "3" "2024\-08\-06" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_domain" "3" "2024\-08\-23" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -652,7 +652,7 @@ Specifies the type of address vectors that are usable with this domain. For additional details on AV type, see \f[C]fi_av\f[R](3). The following values may be specified. .TP -\f[I]FI_AV_MAP\f[R] +\f[I]FI_AV_MAP\f[R] (deprecated) Only address vectors of type AV map are requested or supported. .TP \f[I]FI_AV_TABLE\f[R] @@ -906,8 +906,8 @@ Providers which support authorization keys and connectionless endpoint must support this option. .SS Max Error Data Size (max_err_data) .PP -: The maximum amount of error data, in bytes, that may be returned as -part of a completion or event queue error. +The maximum amount of error data, in bytes, that may be returned as part +of a completion or event queue error. This value corresponds to the err_data_size field in struct fi_cq_err_entry and struct fi_eq_err_entry. .SS Memory Regions Count (mr_cnt) @@ -929,7 +929,7 @@ endpoints created within the domain. See \f[C]fi_endpoint\f[R](3) for additional information. .SS Max Authorization Keys per Endpoint (max_ep_auth_key) .PP -: The maximum number of authorization keys which can be supported per +The maximum number of authorization keys which can be supported per connectionless endpoint. .SS Maximum Peer Group Id (max_group_id) .PP diff --git a/man/man3/fi_endpoint.3 b/man/man3/fi_endpoint.3 index b245401c142..a9dad7e3d40 100644 --- a/man/man3/fi_endpoint.3 +++ b/man/man3/fi_endpoint.3 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.9.2.1 .\" -.TH "fi_endpoint" "3" "2024\-08\-06" "Libfabric Programmer\[cq]s Manual" "#VERSION#" +.TH "fi_endpoint" "3" "2024\-08\-23" "Libfabric Programmer\[cq]s Manual" "#VERSION#" .hy .SH NAME .PP @@ -479,19 +479,19 @@ struct fi_info. The following control commands and arguments may be assigned to an endpoint. .TP -**FI_BACKLOG - int *value** +\f[I]FI_BACKLOG - int *value\f[R] This option only applies to passive endpoints. It is used to set the connection request backlog for listening endpoints. .TP -**FI_GETOPSFLAG \[en] uint64_t *flags** +\f[I]FI_GETOPSFLAG \[en] uint64_t *flags\f[R] Used to retrieve the current value of flags associated with the data transfer operations initiated on the endpoint. The control argument must include FI_TRANSMIT or FI_RECV (not both) flags to indicate the type of data transfer flags to be returned. See below for a list of control flags. .TP -\f[B]FI_GETWAIT \[en] void **\f[R] +\f[I]FI_GETWAIT \[en] void **\f[R] This command allows the user to retrieve the file descriptor associated with a socket endpoint. The fi_control arg parameter should be an address where a pointer to the @@ -500,7 +500,7 @@ See fi_eq.3 for addition details using fi_control with FI_GETWAIT. The file descriptor may be used for notification that the endpoint is ready to send or receive data. .TP -**FI_SETOPSFLAG \[en] uint64_t *flags** +\f[I]FI_SETOPSFLAG \[en] uint64_t *flags\f[R] Used to change the data transfer operation flags associated with an endpoint. The control argument must include FI_TRANSMIT or FI_RECV (not both) to