diff options
| author | Jim Warner <james.warner@comcast.net> | 2021-10-14 00:00:00 -0500 |
|---|---|---|
| committer | Craig Small <csmall@dropbear.xyz> | 2021-10-18 17:38:43 +1100 |
| commit | b652c35f7f4d0fe644df4c756ef96cb4fd08a9f8 (patch) | |
| tree | b3929fe60548d0d2c068a381ae77bf8397c87c8c /doc | |
| parent | be1ddc275623b6cf16060d8a0fa1fb36f677010a (diff) | |
| download | procps-ng-b652c35f7f4d0fe644df4c756ef96cb4fd08a9f8.tar.gz | |
doc: added the new valgrind 'warning-suppression' file
Signed-off-by: Jim Warner <james.warner@comcast.net>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/procps_pids.3 | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/procps_pids.3 b/doc/procps_pids.3 index 3de5061..2a91cc8 100644 --- a/doc/procps_pids.3 +++ b/doc/procps_pids.3 @@ -172,9 +172,20 @@ However, if one survives the \fBfatal_proc_unmounted\fR call, NULL is always returned when \fIreturn_self\fR is zero. .SH DEBUGGING -To aid in program development, there is a provision that can -help ensure `result' member references agree with library -expectations. +To aid in program development, there are two procps-ng provisions +that can be exploited. + +The first is a supplied file named `libproc.supp' which may be +useful when developing a \fImulti-threaded\fR application. +When used with the valgrind `--suppressions=' option, warnings +associated with the procps library itself are avoided. + +Such warnings arise because the library handles heap based +allocations in a thread-safe manner. +A \fIsingle-threaded\fR application will not receive those warnings. + +The second provision 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. @@ -183,7 +194,7 @@ methods and any discrepancies will be written to \fBstderr\fR. .IP 1) 3 Add CFLAGS='-DXTRA_PROCPS_DEBUG' to any other ./configure -options employed. +options your project may employ. .IP 2) 3 Add #include <procps/xtra-procps-debug.h> to any program |