librdmacm/man: Add the manual page for rdma_freeaddrinfo

Add the manual page for rdma_freeaddrinfo. Signed-off-by: Mark Zhang <[email protected]> Reviewed-by: Maher Sanalla <[email protected]> Signed-off-by: Yishai Hadas <[email protected]>
linux-rdma · Feb 4, 2025 · dca0a8a · dca0a8a
1 parent aac4923
commit dca0a8a
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 1 deletion.
diff --git a/librdmacm/man/CMakeLists.txt b/librdmacm/man/CMakeLists.txt
@@ -23,6 +23,7 @@ rdma_man_pages(
   rdma_establish.3.md
   rdma_event_str.3
   rdma_free_devices.3
+  rdma_freeaddrinfo.3.in.rst
   rdma_get_cm_event.3
   rdma_get_devices.3
   rdma_get_dst_port.3

diff --git a/librdmacm/man/rdma_cm.7 b/librdmacm/man/rdma_cm.7
@@ -115,6 +115,8 @@ destroy the QP
 release the rdma_cm_id
 .IP rdma_destroy_event_channel
 release the event channel
+.IP rdma_freeaddrinfo
+release the list of rdma_addrinfo structures
 .IP rdma_set_local_ece
 set desired ECE options
 .P
@@ -201,6 +203,7 @@ rdma_destroy_qp(3),
 rdma_disconnect(3),
 rdma_event_str(3),
 rdma_free_devices(3),
+rdma_freeaddrinfo(3),
 rdma_getaddrinfo(3),
 rdma_get_cm_event(3),
 rdma_get_devices(3),

diff --git a/librdmacm/man/rdma_freeaddrinfo.3.in.rst b/librdmacm/man/rdma_freeaddrinfo.3.in.rst
@@ -0,0 +1,44 @@
+=================
+RDMA_FREEADDRINFO
+=================
+
+-----------------------------------------------------------------------
+Frees the list of rdma_addrinfo structures returned by rdma_getaddrinfo
+-----------------------------------------------------------------------
+
+:Date: 2025-02-03
+:Manual section: 3
+:Manual group: Librdmacm Programmer's Manual
+
+
+SYNOPSIS
+========
+
+#include <rdma/rdma_cma.h>
+
+void rdma_freeaddrinfo (struct rdma_addrinfo \*res);
+
+ARGUMENTS
+=========
+
+res	List of rdma_addrinfo structures returned by rdma_getaddrinfo.
+
+DESCRIPTION
+===========
+
+Frees the list of rdma_addrinfo structures returned by rdma_getaddrinfo.
+
+RETURN VALUE
+============
+
+None
+
+SEE ALSO
+========
+
+rdma_getaddrinfo(3)
+
+AUTHOR
+======
+
+Mark Zhang <[email protected]>
diff --git a/librdmacm/man/rdma_getaddrinfo.3 b/librdmacm/man/rdma_getaddrinfo.3
@@ -131,4 +131,4 @@ Pointer to the next rdma_addrinfo structure in the list.  Will be NULL
 if no more structures exist.
 .SH "SEE ALSO"
 rdma_create_id(3), rdma_resolve_route(3), rdma_connect(3), rdma_create_qp(3),
-rdma_bind_addr(3), rdma_create_ep(3)
+rdma_bind_addr(3), rdma_create_ep(3), rdma_freeaddrinfo(3)