From: Jason Gunthorpe <jgg@xxxxxxxxxxxx> Simple scripted conversion Signed-off-by: Jason Gunthorpe <jgg@xxxxxxxxxxxx> --- libibumad/man/CMakeLists.txt | 2 +- libibumad/man/umad_init.3 | 40 ------------------------------ libibumad/man/umad_init.3.md | 47 ++++++++++++++++++++++++++++++++++++ 3 files changed, 48 insertions(+), 41 deletions(-) delete mode 100644 libibumad/man/umad_init.3 create mode 100644 libibumad/man/umad_init.3.md diff --git a/libibumad/man/CMakeLists.txt b/libibumad/man/CMakeLists.txt index 4831d3b1625c9d..185584a0369cf2 100644 --- a/libibumad/man/CMakeLists.txt +++ b/libibumad/man/CMakeLists.txt @@ -15,7 +15,7 @@ rdma_man_pages( umad_get_mad_addr.3 umad_get_pkey.3 umad_get_port.3 - umad_init.3 + umad_init.3.md umad_open_port.3 umad_poll.3 umad_recv.3 diff --git a/libibumad/man/umad_init.3 b/libibumad/man/umad_init.3 deleted file mode 100644 index 64366b9de7e484..00000000000000 --- a/libibumad/man/umad_init.3 +++ /dev/null @@ -1,40 +0,0 @@ -.\" -*- nroff -*- -.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md -.\" -.TH UMAD_INIT 3 "May 21, 2007" "OpenIB" "OpenIB Programmer\'s Manual" -.SH "NAME" -umad_init, umad_done \- perform library initialization and finalization -.SH "SYNOPSIS" -.nf -.B #include <infiniband/umad.h> -.sp -.BI "int umad_init(void); -.sp -.BI "int umad_done(void); -.fi -.SH "DESCRIPTION" -.B umad_init() -initializes the umad library for use. Must be called before any -other call to this library. -.PP -.B umad_done() -finalizes the use of the umad library. -.SH "RETURN VALUE" -.B umad_init() -and -.B umad_done() -return 0 on success, and \-1 on error. -Error is returned from -.B umad_init() -if infiniband umad -can\'t be opened, or the abi version doesn\'t match. -There are no errors currently returned by -.B umad_done(). -.SH "NOTES" -If an error occurs during the library initialization, no further use of the -umad library should be attempted. -.SH "AUTHORS" -.TP -Hal Rosenstock <halr@xxxxxxxxxxxx> -.TP -Dotan Barak <dotanb@xxxxxxxxxxxxxx> diff --git a/libibumad/man/umad_init.3.md b/libibumad/man/umad_init.3.md new file mode 100644 index 00000000000000..b55676d5f96908 --- /dev/null +++ b/libibumad/man/umad_init.3.md @@ -0,0 +1,47 @@ +--- +date: "May 21, 2007" +footer: "OpenIB" +header: "OpenIB Programmer's Manual" +layout: page +license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md' +section: 3 +title: UMAD_INIT +--- + +# NAME + +umad_init, umad_done - perform library initialization and finalization + +# SYNOPSIS + +```c +#include <infiniband/umad.h> + +int umad_init(void); + +int umad_done(void); +``` + +# DESCRIPTION + +**umad_init()** initializes the umad library for use. Must be called before +any other call to this library. + +**umad_done()** finalizes the use of the umad library. + +# RETURN VALUE + +**umad_init()** and **umad_done()** return 0 on success, and -1 on error. +Error is returned from **umad_init()** if infiniband umad can't be opened, or +the abi version doesn't match. There are no errors currently returned by +**umad_done().** + +# NOTES + +If an error occurs during the library initialization, no further use of the +umad library should be attempted. + +# AUTHORS + +Dotan Barak <dotanb@xxxxxxxxxxxxxx>, +Hal Rosenstock <halr@xxxxxxxxxxxx> -- 2.17.0 -- To unsubscribe from this list: send the line "unsubscribe linux-rdma" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
