[PATCH 1/1] Libibumad: Clarify the man page for function umad_get_ca_portguids

jay.p.patel-ral2JQCrhuEAvxtiuMwx3w
2016-08-08T17:49:58Z

From: Jay Patel <jay.p.patel-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Clarified the return value explanation of umad_get_ca_portguids() in
corresponding man page.

Signed-off-by: Jay Patel <jay.p.patel-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
man/umad_get_ca_portguids.3 | 3 +++
1 file changed, 3 insertions(+)

diff --git a/man/umad_get_ca_portguids.3 b/man/umad_get_ca_portguids.3
index 3512649..ff8d433 100644
--- a/man/umad_get_ca_portguids.3
+++ b/man/umad_get_ca_portguids.3
@@ -29,6 +29,9 @@ uint64_t entries.
On success,
.B umad_get_ca_portguids()
returns a non-negative value equal to the number of port GUIDs actually filled.
+Not all filled entries may be valid. Invalid entries will be 0.
+For example, calling function on computing node with only one port returns a value of 2.
+The value at index zero will be invalid as it is reserved for switches.
On failure, a negative value is returned.
.SH "SEE ALSO"
.BR umad_get_cas_names (3)
--
1.8.2.3