summaryrefslogtreecommitdiff
path: root/usr/src/man/man3proc/Pmapping_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/Pmapping_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/Pmapping_iter.3proc')
-rw-r--r--usr/src/man/man3proc/Pmapping_iter.3proc46
1 files changed, 26 insertions, 20 deletions
diff --git a/usr/src/man/man3proc/Pmapping_iter.3proc b/usr/src/man/man3proc/Pmapping_iter.3proc
index b60d06ad50..7f2fb46124 100644
--- a/usr/src/man/man3proc/Pmapping_iter.3proc
+++ b/usr/src/man/man3proc/Pmapping_iter.3proc
@@ -64,16 +64,17 @@ the
.Sy prmap_t
structure defined from
.Xr proc 4 ,
-and a name of the mapping. The way that the name is obtained varies
-based on whether one calls
+and a name of the mapping.
+The way that the name is obtained varies based on whether one calls
.Fn Pmapping_iter
or
.Fn Pmapping_iter_resolved .
In both cases, the dynamic linker is consulted to determine the file
-name for the mapping, if it's known. If the name is unknown, for example
-an anonymous mapping, then the
+name for the mapping, if it's known.
+If the name is unknown, for example an anonymous mapping, then the
.Dv NULL
-pointer is passed in for the name. In the case of the
+pointer is passed in for the name.
+In the case of the
.Fn Pmapping_iter_resolved
function the system tries to resolve it to a complete file system path.
If that fails, it falls back to the information from the dynamic linker,
@@ -88,20 +89,24 @@ see
.Pp
The return value of
.Fa func
-controls whether or not iteration continues. If
+controls whether or not iteration continues.
+If
.Fa func
returns
.Sy 0
-then iteration continues. If
+then iteration continues.
+If
.Fa func
returns non-zero then iteration will halt and the value will be
-returned to the caller. Because
+returned to the caller.
+Because
.Sy -1
-indicates internal failure, it is recommended that the callback
-function not return
+indicates internal failure, it is recommended that the callback function not
+return
.Sy -1
-to indicate an error itself. This allows the caller to distinguish
-between failure of the callback function versus failure of the
+to indicate an error itself.
+This allows the caller to distinguish between failure of the callback function
+versus failure of the
.Fn Pmapping_iter
and
.Fn Pmapping_iter_resolved
@@ -115,13 +120,13 @@ functions are similar to the
.Fn Pmapping_iter
and
.Fn Pmapping_iter_resolved
-functions. Except, rather than iterating over every mapping, they
-iterate over the objects that the process has loaded by the dynamic
-linker. For example, an anonymous mapping will show up when iterating
-mappings, but will not show up when iterating objects. Further, while
-most dynamic shared objects have multiple mappings for the text and
-data sections, there will only be a single object that is iterated
-over.
+functions.
+Except, rather than iterating over every mapping, they iterate over the objects
+that the process has loaded by the dynamic linker.
+For example, an anonymous mapping will show up when iterating mappings, but will
+not show up when iterating objects.
+Further, while most dynamic shared objects have multiple mappings for the text
+and data sections, there will only be a single object that is iterated over.
.Pp
The distinction between the
.Fn Pobject_iter
@@ -143,7 +148,8 @@ functions return
.Sy 0.
Otherwise, if there was an internal error 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