]> granicus.if.org Git - procps-ng/commitdiff
docs: tweak both of those newly created man docs a tad
authorJim Warner <james.warner@comcast.net>
Tue, 23 Jun 2020 22:29:14 +0000 (17:29 -0500)
committerCraig Small <csmall@dropbear.xyz>
Thu, 25 Jun 2020 10:08:22 +0000 (20:08 +1000)
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>
doc/procps.3
doc/procps_pids.3

index 96a69574564469f2b7c4323e001d56ba116bb5f7..8eb882c7e3680b858e67ff58fd3550575dbe5b24 100644 (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
 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.
 
index 99a4e5ba34faf5a902e09626d19a787a0e2c236b..f538044b66aca953e49699be14ee1faeaeb10af8 100644 (file)
@@ -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.