summaryrefslogtreecommitdiff
path: root/usr/src/man/man3proc/Penv_iter.3proc
diff options
context:
space:
mode:
authorYuri Pankov <yuri.pankov@nexenta.com>2017-05-29 03:56:19 +0300
committerGordon Ross <gwr@nexenta.com>2017-06-07 11:12:34 -0400
commit72d3dbb9ab4481606cb93caca98ba3b3a8eb6ce2 (patch)
treeb1e1409d1dc0ac3c433224c0cde7c97d01e98d5c /usr/src/man/man3proc/Penv_iter.3proc
parentcb4d790db8fe85bce9f9647fe4e1bdc274c7af1c (diff)
downloadillumos-joyent-72d3dbb9ab4481606cb93caca98ba3b3a8eb6ce2.tar.gz
8300 fix man page issues found by mandoc 1.14.1
Reviewed by: Robert Mustacchi <rm@joyent.com> Reviewed by: Toomas Soome <tsoome@me.com> Approved by: Gordon Ross <gwr@nexenta.com>
Diffstat (limited to 'usr/src/man/man3proc/Penv_iter.3proc')
-rw-r--r--usr/src/man/man3proc/Penv_iter.3proc17
1 files changed, 9 insertions, 8 deletions
diff --git a/usr/src/man/man3proc/Penv_iter.3proc b/usr/src/man/man3proc/Penv_iter.3proc
index 84fae69969..8dc616ee0f 100644
--- a/usr/src/man/man3proc/Penv_iter.3proc
+++ b/usr/src/man/man3proc/Penv_iter.3proc
@@ -35,18 +35,18 @@ For each environment variable,
.Fa func
is passed the caller argument
.Fa data
-along with the address of the environment variable and the key-value
-pair. For the full signature of the
+along with the address of the environment variable and the key-value pair.
+For the full signature of the
.Ft proc_env_f
callback, see
.Xr libproc 3LIB .
.Pp
-The callback's return value controls whether or not iteration
-proceeds. If
+The callback's return value controls whether or not iteration proceeds.
+If
.Fa func
-returns zero, then iteration continues. Otherwise, iteration is
-terminated and the value is returned. It is recommended that callback
-functions do not return
+returns zero, then iteration continues.
+Otherwise, iteration is terminated and the value is returned.
+It is recommended that callback functions do not return
.Sy -1
so as to distinguish between the failure of the
.Fn Penv_iter
@@ -59,7 +59,8 @@ function returns
Otherwise, if there was an internal error, for example due to a
corrupted environment, then
.Sy -1
-is returned. Otherwise, if the callback function
+is returned.
+Otherwise, if the callback function
.Fa func
returns non-zero, then its return value will be returned instead.
.Sh INTERFACE STABILITY