From 00bb5504cc62693e05ff4e699f379011c55ecc84 Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Thu, 3 Nov 2016 13:16:26 -0400 Subject: [PATCH] Update CRYPTO_set_mem_debug() doc Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/1842) --- doc/man3/OPENSSL_malloc.pod | 6 ++++-- 1 file 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 argument of