[Pkg-ofed-commits] [libfabric] 63/123: Updated nroff-generated man pages

[Ana Beatriz Guerrero López]

This is an automated email from the git hooks/post-receive script.

ana pushed a commit to annotated tag v1.1.1
in repository libfabric.

commit dc3a4a83dd29fc789f0dcad2b862c342ec5b3f52
Author: OFIWG Bot <ofiwg at lists.openfabrics.org>
Date:   Thu Sep 10 09:36:07 2015 -0700

    Updated nroff-generated man pages
---
 man/man7/fi_sockets.7 | 44 +++++++++++++++++++++++++++++++++++++++++++-
 man/man7/fi_verbs.7   |  6 ++----
 2 files changed, 45 insertions(+), 5 deletions(-)

diff --git a/man/man7/fi_sockets.7 b/man/man7/fi_sockets.7
index 40678a3..60d275a 100644
--- a/man/man7/fi_sockets.7
+++ b/man/man7/fi_sockets.7
@@ -1,4 +1,4 @@
-.TH fi_sockets 7 "2015\-05\-05" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@"
+.TH fi_sockets 7 "2015\-09\-10" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@"
 .SH NAME
 .PP
 The Sockets Fabric Provider
@@ -44,6 +44,48 @@ implemented over TCP sockets.
 As a result, the performance numbers are lower compared to other
 providers implemented over high-speed fabric, and lower than what an
 application might see implementing to sockets directly.
+.SH RUNTIME PARAMETERS
+.PP
+The sockets provider checks for the following environment variables -
+.PP
+\f[I]FI_SOCKETS_PE_WAITTIME\f[] : An integer value that specifies how
+many milliseconds to spin while waiting for progress in
+\f[I]FI_PROGRESS_AUTO\f[] mode.
+.PP
+\f[I]FI_SOCKETS_MAX_CONN_RETRY\f[] : An integer value that specifies the
+number of socket connection retries before reporting as failure.
+.PP
+\f[I]FI_SOCKETS_DEF_CONN_MAP_SZ\f[] : An integer to specify the default
+connection map size.
+.PP
+\f[I]FI_SOCKETS_DEF_AV_SZ\f[] : An integer to specify the default
+address vector size.
+.PP
+\f[I]FI_SOCKETS_DEF_CQ_SZ\f[] : An integer to specify the default
+completion queue size.
+.PP
+\f[I]FI_SOCKETS_DEF_EQ_SZ\f[] : An integer to specify the default event
+queue size.
+.PP
+\f[I]FI_SOCKETS_DGRAM_DROP_RATE\f[] : An integer value to specify the
+drop rate of dgram frame when endpoint is \f[I]FI_EP_DGRAM\f[].
+This is for debugging purpose only.
+.PP
+\f[I]FI_SOCKETS_PE_AFFINITY\f[] : If specified, progress thread is bound
+to the indicated range(s) of Linux virtual processor ID(s).
+This option is currently not supported on OS X.
+The usage is - id_start[-id_end[:stride]][,].
+.SH LARGE SCALE JOBS
+.PP
+For large scale runs one can use these environment variables to set the
+default parameters e.g.
+size of the address vector(AV), completion queue (CQ), connection map
+etc.
+that satisfies the requriment of the particular benchmark.
+The recommended parameters for large scale runs are
+\f[I]FI_SOCKETS_MAX_CONN_RETRY\f[], \f[I]FI_SOCKETS_DEF_CONN_MAP_SZ\f[],
+\f[I]FI_SOCKETS_DEF_AV_SZ\f[], \f[I]FI_SOCKETS_DEF_CQ_SZ\f[],
+\f[I]FI_SOCKETS_DEF_EQ_SZ\f[].
 .SH SEE ALSO
 .PP
 \f[C]fabric\f[](7), \f[C]fi_provider\f[](7), \f[C]fi_getinfo\f[](3)
diff --git a/man/man7/fi_verbs.7 b/man/man7/fi_verbs.7
index ff626d1..f2dcc27 100644
--- a/man/man7/fi_verbs.7
+++ b/man/man7/fi_verbs.7
@@ -1,4 +1,4 @@
-.TH fi_verbs 7 "2015\-04\-28" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@"
+.TH fi_verbs 7 "2015\-09\-10" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@"
 .SH NAME
 .PP
 The Verbs Fabric Provider
@@ -7,7 +7,7 @@ The Verbs Fabric Provider
 The verbs provider enables applications using OFI to be run over any
 verbs hardware (Infiniband, iWarp, etc).
 It uses the Linux Verbs API for network transport and provides a
-translation OFI calls to appropriate verbs API calls.
+translation of OFI calls to appropriate verbs API calls.
 It uses librdmacm for communication management and libibverbs for other
 control and data transfer operations.
 .SH SUPPORTED FEATURES
@@ -52,8 +52,6 @@ management, polling.
 .PP
 \f[I]CQ\f[] : cq_readfrom operations are not supported.
 .PP
-\f[I]CM\f[] : fi_setname is not yet supported.
-.PP
 \f[I]EQ\f[] : fi_eq_write is not supported.
 .PP
 \f[I]Memory Regions\f[] : Adding regions via s/g list is not supported.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ofed/libfabric.git