[ofa-general] [PATCH] libibumad/man: umad_get_issm_path() man page

[Sasha Khapyorsky]

Man page for umad_get_issm_path().

Signed-off-by: Sasha Khapyorsky <sashak at voltaire.com>
---
 libibumad/Makefile.am              |    3 +-
 libibumad/man/umad_get_issm_path.3 |   38 ++++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 1 deletions(-)
 create mode 100644 libibumad/man/umad_get_issm_path.3

diff --git a/libibumad/Makefile.am b/libibumad/Makefile.am
index dd4a996..7674654 100644
--- a/libibumad/Makefile.am
+++ b/libibumad/Makefile.am
@@ -13,7 +13,8 @@ man_MANS = man/umad_debug.3 man/umad_get_ca.3 \
 	   man/umad_set_grh_net.3 man/umad_set_grh.3 \
 	   man/umad_set_addr_net.3 man/umad_set_addr.3 man/umad_set_pkey.3 \
 	   man/umad_register.3 man/umad_register_oui.3 man/umad_unregister.3 \
-	   man/umad_send.3 man/umad_recv.3 man/umad_poll.3
+	   man/umad_send.3 man/umad_recv.3 man/umad_poll.3 \
+	   man/umad_get_issm_path.3
 
 lib_LTLIBRARIES = libibumad.la
 
diff --git a/libibumad/man/umad_get_issm_path.3 b/libibumad/man/umad_get_issm_path.3
new file mode 100644
index 0000000..ac538c9
--- /dev/null
+++ b/libibumad/man/umad_get_issm_path.3
@@ -0,0 +1,38 @@
+.\" -*- nroff -*-
+.\"
+.TH UMAD_GET_ISSM_PATH 3  "Oct 18, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
+.SH "NAME"
+umad_get_issm_path \- get path of issm device
+.SH "SYNOPSIS"
+.nf
+.B #include <infiniband/umad.h>
+.sp
+.BI "int umad_get_issm_path(char " "*ca_name" ", int " "portnum", char *path, int max);
+.fi
+.SH "DESCRIPTION"
+.B umad_get_issm_path()
+resolves path to issm device (which used for setting/clearing PortInfo:CapMask IsSM bit) for
+.I portnum
+of the IB device
+.I ca_name
+, it stores resolved path in
+.I path
+array which cannot exceed
+.I max
+bytes in length (including NULL terminator).
+.fi
+Opening issm device sets PortInfo:CapMask IsSM bit and closing clears it.
+.fi
+.SH "RETURN VALUE"
+.B umad_open_port()
+returns 0 on success and a negative value on error as follows:
+ -ENODEV IB device can\'t be resolved
+ -EINVAL port is not valid (bad
+.I portnum\fR
+or no umad device)
+.SH "SEE ALSO"
+.BR umad_open_port (3),
+.BR umad_get_port (3)
+.SH "AUTHOR"
+.TP
+Sasha Khapyorsky <sashak at voltaire.com>
-- 
1.5.3.4.206.g58ba4