From: Jason Gunthorpe <jgg@xxxxxxxxxxxx> To make edits to it. Signed-off-by: Jason Gunthorpe <jgg@xxxxxxxxxxxx> --- libibverbs/man/CMakeLists.txt | 2 +- libibverbs/man/ibv_get_device_list.3 | 67 ---------------------- libibverbs/man/ibv_get_device_list.3.md | 75 +++++++++++++++++++++++++ 3 files changed, 76 insertions(+), 68 deletions(-) delete mode 100644 libibverbs/man/ibv_get_device_list.3 create mode 100644 libibverbs/man/ibv_get_device_list.3.md diff --git a/libibverbs/man/CMakeLists.txt b/libibverbs/man/CMakeLists.txt index 234b34e86d4e1c..6efd6713f2aeee 100644 --- a/libibverbs/man/CMakeLists.txt +++ b/libibverbs/man/CMakeLists.txt @@ -31,7 +31,7 @@ rdma_man_pages( ibv_get_async_event.3 ibv_get_cq_event.3 ibv_get_device_guid.3.md - ibv_get_device_list.3 + ibv_get_device_list.3.md ibv_get_device_name.3.md ibv_get_pkey_index.3.md ibv_get_srq_num.3.md diff --git a/libibverbs/man/ibv_get_device_list.3 b/libibverbs/man/ibv_get_device_list.3 deleted file mode 100644 index 71c4a740ec23eb..00000000000000 --- a/libibverbs/man/ibv_get_device_list.3 +++ /dev/null @@ -1,67 +0,0 @@ -.\" -*- nroff -*- -.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md -.\" -.TH IBV_GET_DEVICE_LIST 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual" -.SH "NAME" -ibv_get_device_list, ibv_free_device_list \- get and release list of available RDMA devices -.SH "SYNOPSIS" -.nf -.B #include <infiniband/verbs.h> -.sp -.BI "struct ibv_device **ibv_get_device_list(int " "*num_devices" ); -.sp -.BI "void ibv_free_device_list(struct ibv_device " "**list" ); -.fi -.SH "DESCRIPTION" -.B ibv_get_device_list() -returns a NULL-terminated array of RDMA devices currently available. -The argument -.I num_devices -is optional; if not NULL, it is set to the number of devices returned in the array. -.PP -.B ibv_free_device_list() -frees the array of devices -.I list -returned by -.B ibv_get_device_list()\fR. -.SH "RETURN VALUE" -.B ibv_get_device_list() -returns the array of available RDMA devices, or sets -.I errno -and returns NULL if the request fails. If no devices are found then -.I num_devices -is set to 0, and non-NULL is returned. -.PP -.B ibv_free_device_list() -returns no value. -.SH "ERRORS" -.TP -.B EPERM -Permission denied. -.TP -.B ENOSYS -No kernel support for RDMA. -.TP -.B ENOMEM -Insufficient memory to complete the operation. -.SH "NOTES" -Client code should open all the devices it intends to use with -.B ibv_open_device()\fR before calling -.B ibv_free_device_list()\fR. -Once it frees the array with -.B ibv_free_device_list()\fR, -it will be able to use only the open devices; pointers to unopened devices will no longer be valid. -.P -Setting the environment variable -.BR IBV_SHOW_WARNINGS -will cause warnings to be emitted to stderr if a kernel verbs device -is discovered, but no corresponding userspace driver can be found for -it. -.SH "SEE ALSO" -.BR ibv_fork_init (3), -.BR ibv_get_device_name (3), -.BR ibv_get_device_guid (3), -.BR ibv_open_device (3) -.SH "AUTHORS" -.TP -Dotan Barak <dotanba@xxxxxxxxx> diff --git a/libibverbs/man/ibv_get_device_list.3.md b/libibverbs/man/ibv_get_device_list.3.md new file mode 100644 index 00000000000000..3f2ba8b8f5577e --- /dev/null +++ b/libibverbs/man/ibv_get_device_list.3.md @@ -0,0 +1,75 @@ +--- +date: 2006-10-31 +footer: libibverbs +header: "Libibverbs Programmer's Manual" +layout: page +license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md' +section: 3 +title: IBV_GET_DEVICE_LIST +--- + +# NAME + +ibv_get_device_list, ibv_free_device_list - get and release list of available +RDMA devices + +# SYNOPSIS + +```c +#include <infiniband/verbs.h> + +struct ibv_device **ibv_get_device_list(int *num_devices); + +void ibv_free_device_list(struct ibv_device **list); +``` + +# DESCRIPTION + +**ibv_get_device_list()** returns a NULL-terminated array of RDMA devices +currently available. The argument *num_devices* is optional; if not NULL, it +is set to the number of devices returned in the array. + +**ibv_free_device_list()** frees the array of devices *list* returned by +**ibv_get_device_list()**. + +# RETURN VALUE + +**ibv_get_device_list()** returns the array of available RDMA devices, or sets +*errno* and returns NULL if the request fails. If no devices are found then +*num_devices* is set to 0, and non-NULL is returned. + +**ibv_free_device_list()** returns no value. + +# ERRORS + +**EPERM** +: Permission denied. + +**ENOSYS** +: No kernel support for RDMA. + +**ENOMEM** +: Insufficient memory to complete the operation. + + +# NOTES + +Client code should open all the devices it intends to use with +**ibv_open_device()** before calling **ibv_free_device_list()**. Once it frees +the array with **ibv_free_device_list()**, it will be able to use only the +open devices; pointers to unopened devices will no longer be valid. + +Setting the environment variable **IBV_SHOW_WARNINGS** will cause warnings to +be emitted to stderr if a kernel verbs device is discovered, but no +corresponding userspace driver can be found for it. + +# SEE ALSO + +**ibv_fork_init**(3), +**ibv_get_device_guid**(3), +**ibv_get_device_name**(3), +**ibv_open_device**(3) + +# AUTHOR + +Dotan Barak <dotanba@xxxxxxxxx> -- 2.19.0
