emo/procps
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity

docs: tweak both of those newly created man docs a tad

Browse Source 
An important fact was omitted in the DEBUGGING section
for the two newest man documents. Users must utilize a
macro in the header files before verification happens.

So, this commit will sneak in such mention and in that
way reduce future liability if the feature won't work.

Signed-off-by: Jim Warner <james.warner@comcast.net>
This commit is contained in:
Jim Warner 2020-06-23 17:29:14 -05:00 committed by Craig Small
parent d64755ea5f
commit 9b3436e0e4
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/procps.3
View File

@ -151,6 +151,9 @@ Success is indicated by a pointer to the named structure.
To aid in program development, there is a provision that can To aid in program development, there is a provision that can
help ensure `result' member references agree with library help ensure `result' member references agree with library
expectations. expectations.
It assumes that a supplied macro in the header file is
used to access the `result' value.
This feature can be activated through either of the following This feature can be activated through either of the following
methods and any discrepancies will be wrtten to \fBstderr\fR. methods and any discrepancies will be wrtten to \fBstderr\fR.

10
doc/procps_pids.3
View File

@ -97,9 +97,10 @@ The following would be a typical sequence of calls to
this interface. this interface.
.nf .nf
.RB "1. " procps_pids_new() .RB "1. " fatal_proc_unmounted()
.RB "2. " procps_pids_get() ", " procps_pids_reap() " or " procps_pids_select() .RB "2. " procps_pids_new()
.RB "3. " procps_pids_unref() .RB "3. " procps_pids_get() ", " procps_pids_reap() " or " procps_pids_select()
.RB "4. " procps_pids_unref()
.fi .fi
Optionally, a user may choose to sort results returned from Optionally, a user may choose to sort results returned from
@ -158,6 +159,9 @@ Success is indicated by a pointer to the named structure.
To aid in program development, there is a provision that can To aid in program development, there is a provision that can
help ensure `result' member references agree with library help ensure `result' member references agree with library
expectations. expectations.
It assumes that a supplied macro in the header file is
used to access the `result' value.
This feature can be activated through either of the following This feature can be activated through either of the following
methods and any discrepancies will be wrtten to \fBstderr\fR. methods and any discrepancies will be wrtten to \fBstderr\fR.