summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJim Warner <james.warner@comcast.net>2021-02-03 00:00:00 -0600
committerCraig Small <csmall@dropbear.xyz>2021-02-09 16:40:52 +1100
commit9a0869e8bad938cfafd62bd29230352f86bdc199 (patch)
tree2c9d91979ee32230e75a6ecfb4c4b718dbe5c623 /doc
parent3c87c46439a4cea112b7fc3983b2dab969a0b42a (diff)
downloadprocps-ng-9a0869e8bad938cfafd62bd29230352f86bdc199.tar.gz
docs: bring 2 man pages into agreement regarding sorts
Signed-off-by: Jim Warner <james.warner@comcast.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/procps.37
-rw-r--r--doc/procps_pids.32
2 files changed, 4 insertions, 5 deletions
diff --git a/doc/procps.3 b/doc/procps.3
index fe640ea..bd566ec 100644
--- a/doc/procps.3
+++ b/doc/procps.3
@@ -109,6 +109,8 @@ these interfaces.
Optionally, a user may choose to sort results returned from
a \fBreap\fR function call.
+The \fBsort\fR function parameters \fIstacks\fR and \fInumstacked\fR
+would normally be those returned in the `reaped' structure.
.SS Caveats
The \fBnew\fR, \fBref\fR, \fBunref\fR, \fBget\fR and \fBselect\fR
@@ -127,10 +129,7 @@ The \fBdiskstats\fR, \fBslabinfo\fR and \fBstat\fR interfaces support
unpredictable variable outcomes.
As such, they export a \fBreap\fR function to retrieve multiple `stacks'
with a single invocation.
-
-Those same interfaces also offer a \fBsort\fR function whose
-parameters \fIstacks\fR and \fInumstacked\fR would normally be those
-returned in the `reaped' structure.
+These same interfaces also provide a \fBsort\fR function.
.SH RETURN VALUE
.SS Functions Returning an `int'
diff --git a/doc/procps_pids.3 b/doc/procps_pids.3
index ac33c6c..7fc1880 100644
--- a/doc/procps_pids.3
+++ b/doc/procps_pids.3
@@ -104,7 +104,7 @@ this interface.
.fi
Optionally, a user may choose to sort results returned from
-\fBreap\fR or \fBselect\fR.
+a \fBreap\fR or \fBselect\fR function call.
The \fBsort\fR function parameters \fIstacks\fR and \fInumstacked\fR
would normally be those returned in the `pids_fetch' structure.