DOCS: Don't mention internal functions in public documentation
authorRichard Levitte <levitte@openssl.org>
Sun, 23 May 2021 06:53:34 +0000 (08:53 +0200)
committerPauli <pauli@openssl.org>
Tue, 25 May 2021 00:24:57 +0000 (10:24 +1000)
This time noticed in OSSL_trace_set_channel.pod, and it turned out to
be easy to mention the public functions affected instead.

Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15422)

doc/man3/OSSL_trace_set_channel.pod

index 84dcfb51577718e9805a83942a8ace7b421bff46..7564c6084213c079b001be56a5c7de031b2208bf 100644 (file)
@@ -140,9 +140,10 @@ Traces the ciphers used by the TLS/SSL protocol.
 
 Traces the ENGINE algorithm table selection.
 
-More precisely, engine_table_select(), the function that is used by
-RSA, DSA (etc) code to select registered ENGINEs, cache defaults and
-functional references (etc), will generate trace summaries.
+More precisely, functions like ENGINE_get_pkey_asn1_meth_engine(),
+ENGINE_get_pkey_meth_engine(), ENGINE_get_cipher_engine(),
+ENGINE_get_digest_engine(), will generate trace summaries of the
+handling of internal tables.
 
 =item B<OSSL_TRACE_CATEGORY_ENGINE_REF_COUNT>