From 9b3436e0e4996e03cce18c28b7669cd6d8072d97 Mon Sep 17 00:00:00 2001 From: Jim Warner Date: Tue, 23 Jun 2020 17:29:14 -0500 Subject: [PATCH] docs: tweak both of those newly created man docs a tad 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 --- doc/procps.3 | 3 +++ doc/procps_pids.3 | 10 +++++++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/procps.3 b/doc/procps.3 index 96a69574..8eb882c7 100644 --- a/doc/procps.3 +++ b/doc/procps.3 @@ -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 help ensure `result' member references agree with library 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 methods and any discrepancies will be wrtten to \fBstderr\fR. diff --git a/doc/procps_pids.3 b/doc/procps_pids.3 index 99a4e5ba..f538044b 100644 --- a/doc/procps_pids.3 +++ b/doc/procps_pids.3 @@ -97,9 +97,10 @@ The following would be a typical sequence of calls to this interface. .nf -.RB "1. " procps_pids_new() -.RB "2. " procps_pids_get() ", " procps_pids_reap() " or " procps_pids_select() -.RB "3. " procps_pids_unref() +.RB "1. " fatal_proc_unmounted() +.RB "2. " procps_pids_new() +.RB "3. " procps_pids_get() ", " procps_pids_reap() " or " procps_pids_select() +.RB "4. " procps_pids_unref() .fi 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 help ensure `result' member references agree with library 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 methods and any discrepancies will be wrtten to \fBstderr\fR.