doc: added the new valgrind 'warning-suppression' file
Signed-off-by: Jim Warner <james.warner@comcast.net>
This commit is contained in:
parent
be1ddc2756
commit
b652c35f7f
@ -172,9 +172,20 @@ However, if one survives the \fBfatal_proc_unmounted\fR call,
|
|||||||
NULL is always returned when \fIreturn_self\fR is zero.
|
NULL is always returned when \fIreturn_self\fR is zero.
|
||||||
|
|
||||||
.SH DEBUGGING
|
.SH DEBUGGING
|
||||||
To aid in program development, there is a provision that can
|
To aid in program development, there are two procps-ng provisions
|
||||||
help ensure `result' member references agree with library
|
that can be exploited.
|
||||||
expectations.
|
|
||||||
|
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
|
It assumes that a supplied macro in the header file is
|
||||||
used to access the `result' value.
|
used to access the `result' value.
|
||||||
|
|
||||||
@ -183,7 +194,7 @@ methods and any discrepancies will be written to \fBstderr\fR.
|
|||||||
|
|
||||||
.IP 1) 3
|
.IP 1) 3
|
||||||
Add CFLAGS='-DXTRA_PROCPS_DEBUG' to any other ./configure
|
Add CFLAGS='-DXTRA_PROCPS_DEBUG' to any other ./configure
|
||||||
options employed.
|
options your project may employ.
|
||||||
|
|
||||||
.IP 2) 3
|
.IP 2) 3
|
||||||
Add #include <procps/xtra-procps-debug.h> to any program
|
Add #include <procps/xtra-procps-debug.h> to any program
|
||||||
|
Loading…
Reference in New Issue
Block a user