summaryrefslogtreecommitdiff
path: root/usr
diff options
context:
space:
mode:
authorMarcel Telka <marcel.telka@nexenta.com>2015-02-14 19:20:31 +0100
committerRichard Lowe <richlowe@richlowe.net>2015-02-19 15:07:51 -0500
commitf8a04df97f92f19394b23c2e3d1907ffa0574a64 (patch)
tree53e5edd046646fec57878af2467bb72b28cf9225 /usr
parenta6d8852a981f3ee28e9755ad33299b3652f35761 (diff)
downloadillumos-gate-f8a04df97f92f19394b23c2e3d1907ffa0574a64.tar.gz
5616 netdir(3nsl): Return values should be better documented
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com> Reviewed by: Josef 'Jeff' Sipek <josef.sipek@nexenta.com> Approved by: Richard Lowe <richlowe@richlowe.net>
Diffstat (limited to 'usr')
-rw-r--r--usr/src/man/man3nsl/netdir.3nsl21
1 files changed, 9 insertions, 12 deletions
diff --git a/usr/src/man/man3nsl/netdir.3nsl b/usr/src/man/man3nsl/netdir.3nsl
index 812488c020..310aea1772 100644
--- a/usr/src/man/man3nsl/netdir.3nsl
+++ b/usr/src/man/man3nsl/netdir.3nsl
@@ -1,10 +1,11 @@
'\" te
+.\" Copyright 2015 Nexenta Systems, Inc. All rights reserved.
.\" Copyright 1989 AT&T
.\" Copyright (C) 2005, Sun Microsystems, Inc. All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH NETDIR 3NSL "Dec 25, 2013"
+.TH NETDIR 3NSL "Feb 14, 2015"
.SH NAME
netdir, netdir_getbyname, netdir_getbyaddr, netdir_free, netdir_options,
taddr2uaddr, uaddr2taddr, netdir_perror, netdir_sperror, netdir_mergeaddr \-
@@ -57,7 +58,6 @@ generic transport name-to-address translation
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBnetdir\fR functions provide a generic interface for name-to-address
mapping that will work with all transport protocols. This interface provides a
@@ -180,10 +180,6 @@ struct nd_hostservlist ND_HOSTSERVLIST
.sp
.LP
-The \fBfree()\fR function is used to free the universal address returned by the
-\fBtaddr2uaddr()\fR function.
-.sp
-.LP
The \fBnetdir_options()\fR function is used to do all transport-specific setups
and option management. \fIfildes\fR is the associated file descriptor.
\fIoption\fR, \fIfildes\fR, and \fIpointer_to_args\fR are passed to the
@@ -288,9 +284,13 @@ returns \fINULL\fR if the conversion is not possible. This is not a fatal
condition as some transports do not support a universal address form.
.sp
.LP
+The \fBfree()\fR function is used to free the universal address returned by the
+\fBtaddr2uaddr()\fR function.
+.sp
+.LP
The \fBuaddr2taddr()\fR function is the reverse of the \fBtaddr2uaddr()\fR
function. It returns the \fBstruct netbuf\fR data structure for the given
-universal address.
+universal address and \fINULL\fR on failure.
.sp
.LP
@@ -303,7 +303,6 @@ The \fBnetdir_sperror()\fR function returns a string with an error message that
states the cause of a name-to-address mapping failure.
.SH RETURN VALUES
-.sp
.LP
The \fBnetdir_sperror()\fR function returns a pointer to a buffer which
contains the error message string. The buffer is overwritten on each call. In
@@ -311,10 +310,9 @@ multithreaded applications, this buffer is implemented as thread-specific
data.
.sp
.LP
-The \fBnetdir_getbyaddr()\fR function returns \fB0\fR on success and a non-zero
-value on failure.
+The \fBnetdir_getbyname()\fR, \fBnetdir_getbyaddr()\fR, and \fBnetdir_options()\fR
+functions return \fB0\fR on success and a non-zero value on failure.
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -330,7 +328,6 @@ MT-Level Safe
.TE
.SH SEE ALSO
-.sp
.LP
\fBgethostname\fR(3C), \fBgetnetconfig\fR(3NSL), \fBgetnetpath\fR(3NSL),
\fBnetconfig\fR(4), \fBattributes\fR(5)