Correct the documentation for OPENSSL_MALLOC_FD
authorMatt Caswell <matt@openssl.org>
Tue, 9 Aug 2022 10:55:45 +0000 (11:55 +0100)
committerTomas Mraz <tomas@openssl.org>
Wed, 17 Aug 2022 10:58:41 +0000 (12:58 +0200)
commit5a07d91dc9e787e5e4a2ff5b41bc0ebdcb4efd0a
tree59d5b053da80266833fa3fe671d2085f6dc68a26
parent8bb9fecf6341aad0a771bf585d9eea80ea6ac89d
Correct the documentation for OPENSSL_MALLOC_FD

The documentation was misleading in that it suggests that this environment
variable will record information about all allocations. While this is true
it doesn't record the most useful information that you might expect such
as the requested size of the allocation! It is mainly for use in
conjunction with OPENSSL_MALLOC_FAILURES, and reports information about
what chance an allocation has of failing.

We also clarify that the mem_debug functions are actually no-ops in 3.0.

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/18967)

(cherry picked from commit 2c35d61790603530d11f52eda9132ff8640f9852)
doc/man3/OPENSSL_malloc.pod