Skip to content

Commit a0efeb1

Browse files
committed
Update man page for UDP provider
Change "limitations" section to describe that the maximum transfer size depends on interface MTU, and add FI_UDP_IFACE parameter description. Signed-off-by: Martin Pokorny <[email protected]>
1 parent 2d26352 commit a0efeb1

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

man/fi_udp.7.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,10 @@ receiving datagram messages over an unreliable endpoint.
4141

4242
# LIMITATIONS
4343

44-
The UDP provider has hard-coded maximums for supported queue sizes and data
45-
transfers. These values are reflected in the related fabric attribute
46-
structures
44+
The UDP provider has a hard-coded maximum for supported queue sizes,
45+
which is reflected in the related fabric attribute structures. Maximum
46+
size of data transfers is limited by the MTU size of an interface, and
47+
is also reflected in the related fabric attribute structures.
4748

4849
EPs must be bound to both RX and TX CQs.
4950

@@ -53,7 +54,10 @@ No support for counters.
5354

5455
# RUNTIME PARAMETERS
5556

56-
No runtime parameters are currently defined.
57+
The UDP provider checks for the following environment variables -
58+
59+
*FI_UDP_IFACE*
60+
: An string value that specifies the name of the interface.
5761

5862
# SEE ALSO
5963

0 commit comments

Comments
 (0)