aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man3/OSSL_trace_set_channel.pod
diff options
context:
space:
mode:
authorDr. David von Oheimb <David.von.Oheimb@siemens.com>2022-12-22 11:47:41 +0100
committerHugo Landau <hlandau@openssl.org>2023-01-24 12:31:57 +0000
commitbfd5680e6be789fd554acf2ad34428816a644eec (patch)
treee65ffeab52dd493385a2006889b150c882c4f432 /doc/man3/OSSL_trace_set_channel.pod
parent0fec2121c0c40d8b098896c9bdf629a48fbafa63 (diff)
downloadopenssl-bfd5680e6be789fd554acf2ad34428816a644eec.tar.gz
OSSL_trace_set_channel(): add important statement that it takes BIO ownership
Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Hugo Landau <hlandau@openssl.org> (Merged from https://github.com/openssl/openssl/pull/19959)
Diffstat (limited to 'doc/man3/OSSL_trace_set_channel.pod')
-rw-r--r--doc/man3/OSSL_trace_set_channel.pod2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/man3/OSSL_trace_set_channel.pod b/doc/man3/OSSL_trace_set_channel.pod
index 2d9ce98d42..5b1981c1c3 100644
--- a/doc/man3/OSSL_trace_set_channel.pod
+++ b/doc/man3/OSSL_trace_set_channel.pod
@@ -47,6 +47,8 @@ can be used for producing free-text trace output.
OSSL_trace_set_channel() is used to enable the given trace C<category>
by attaching the B<BIO> I<bio> object as (simple) trace channel.
+On success the ownership of the BIO is transferred to the channel,
+so the caller must not free it directly.
OSSL_trace_set_prefix() and OSSL_trace_set_suffix() can be used to add
an extra line for each channel, to be output before and after group of