diff mbox series

[rdma-core,2/4] rdmacm: Expand on optname in rdma_set_option man page

Message ID 1548683787-18270-3-git-send-email-yishaih@mellanox.com (mailing list archive)
State Not Applicable
Headers show
Series rdmacm: Add option to set ACK timeout | expand

Commit Message

Yishai Hadas Jan. 28, 2019, 1:56 p.m. UTC 
From: Danit Goldberg <danitg@mellanox.com>

Elaborate on each option in rdma_set_option man page.

Signed-off-by: Danit Goldberg <danitg@mellanox.com>
Reviewed-by: Moni Shoua <monis@mellanox.com>
Signed-off-by: Yishai Hadas <yishaih@mellanox.com>
---
 librdmacm/man/rdma_set_option.3 | 13 +++++++++++++
 1 file changed, 13 insertions(+)
diff mbox series

Patch

diff --git a/librdmacm/man/rdma_set_option.3 b/librdmacm/man/rdma_set_option.3
index 93a6047..24b13e4 100644
--- a/librdmacm/man/rdma_set_option.3
+++ b/librdmacm/man/rdma_set_option.3
@@ -25,6 +25,19 @@  The size of the %optval buffer.
 .SH "DESCRIPTION"
 Sets communication options for an rdma_cm_id.  This call is used to override
 the default system settings.
+.IP "optname can be one of" 12
+.IP "RDMA_OPTION_ID_TOS" 12
+Specify the quality of service provided by a connection.
+The expected optlen is size of uint8_t.
+.IP "RDMA_OPTION_ID_REUSEADDR" 12
+Bound the rdma_cm_id to a reuseable address. This will allow other users to bind to that same address.
+The expected optlen is size of int.
+.IP "RDMA_OPTION_ID_AFONLY" 12
+Set IPV6_V6ONLY socket.
+The expected optlen is size of int.
+.IP "RDMA_OPTION_IB_PATH" 12
+Set IB path record data.
+The expected optlen is size of struct ibv_path_data[].
 .SH "RETURN VALUE"
 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
 set to indicate the failure reason.