aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRich Salz <rsalz@openssl.org>2016-11-03 13:16:26 -0400
committerRich Salz <rsalz@openssl.org>2016-11-03 15:25:00 -0400
commit00bb5504cc62693e05ff4e699f379011c55ecc84 (patch)
treebbe66276c2e45cfef29355bcec0ba2f4d392df8c /doc
parent6d4bc8a3d2c2f7701588bbfdea80a1f7a3973f26 (diff)
downloadopenssl-00bb5504cc62693e05ff4e699f379011c55ecc84.tar.gz
Update CRYPTO_set_mem_debug() doc
Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1842)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/OPENSSL_malloc.pod6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/man3/OPENSSL_malloc.pod b/doc/man3/OPENSSL_malloc.pod
index 50f09751cf..2104f43108 100644
--- a/doc/man3/OPENSSL_malloc.pod
+++ b/doc/man3/OPENSSL_malloc.pod
@@ -135,8 +135,10 @@ at build-time).
This adds some overhead by keeping a list of all memory allocations, and
removes items from the list when they are free'd.
This is most useful for identifying memory leaks.
-CRYPTO_set_mem_debug() turns this tracking on and off. It is normally
-called at startup, but can be called at any time.
+CRYPTO_set_mem_debug() turns this tracking on and off. In order to have
+any effect, is must be called before any of the allocation functions
+(e.g., CRYPTO_malloc()) are called, and is therefore normally one of the
+first lines of main() in an application.
CRYPTO_mem_ctrl() provides fine-grained control of memory leak tracking.
To enable tracking call CRYPTO_mem_ctrl() with a B<mode> argument of