summaryrefslogtreecommitdiffstats
path: root/doc/man3/OPENSSL_LH_stats.pod
diff options
context:
space:
mode:
authorHugo Landau <hlandau@openssl.org>2022-03-22 11:52:27 +0000
committerTomas Mraz <tomas@openssl.org>2022-11-21 10:49:52 +0100
commit433471084e4955bbab01d1803a3cf4320031a5c3 (patch)
tree1fee767badf428b0315c24e26d786485c7c7ec3a /doc/man3/OPENSSL_LH_stats.pod
parent2adb7908ef89a01955d9d27365aacff19edf4d57 (diff)
Add deprecation macro for 3.1 and deprecate OPENSSL_LH_stats
Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17937) (cherry picked from commit 5317b6ee1fc3db20de5976fbb46cc49a45c0768a)
Diffstat (limited to 'doc/man3/OPENSSL_LH_stats.pod')
-rw-r--r--doc/man3/OPENSSL_LH_stats.pod15
1 files changed, 13 insertions, 2 deletions
diff --git a/doc/man3/OPENSSL_LH_stats.pod b/doc/man3/OPENSSL_LH_stats.pod
index b86de52cb5..5bc69674f8 100644
--- a/doc/man3/OPENSSL_LH_stats.pod
+++ b/doc/man3/OPENSSL_LH_stats.pod
@@ -10,14 +10,19 @@ OPENSSL_LH_node_stats_bio, OPENSSL_LH_node_usage_stats_bio - LHASH statistics
#include <openssl/lhash.h>
- void OPENSSL_LH_stats(LHASH *table, FILE *out);
void OPENSSL_LH_node_stats(LHASH *table, FILE *out);
void OPENSSL_LH_node_usage_stats(LHASH *table, FILE *out);
- void OPENSSL_LH_stats_bio(LHASH *table, BIO *out);
void OPENSSL_LH_node_stats_bio(LHASH *table, BIO *out);
void OPENSSL_LH_node_usage_stats_bio(LHASH *table, BIO *out);
+The following functions have been deprecated since OpenSSL 3.1, and can be
+hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
+see L<openssl_user_macros(7)>:
+
+ void OPENSSL_LH_stats(LHASH *table, FILE *out);
+ void OPENSSL_LH_stats_bio(LHASH *table, BIO *out);
+
=head1 DESCRIPTION
The B<LHASH> structure records statistics about most aspects of
@@ -43,6 +48,9 @@ record a miss.
OPENSSL_LH_stats_bio(), OPENSSL_LH_node_stats_bio() and OPENSSL_LH_node_usage_stats_bio()
are the same as the above, except that the output goes to a B<BIO>.
+OPENSSH_LH_stats() and OPENSSH_LH_stats_bio() are deprecated and should no
+longer be used.
+
=head1 RETURN VALUES
These functions do not return values.
@@ -53,6 +61,9 @@ These calls should be made under a read lock. Refer to
L<OPENSSL_LH_COMPFUNC(3)/NOTE> for more details about the locks required
when using the LHASH data structure.
+The functions OPENSSH_LH_stats() and OPENSSH_LH_stats_bio() were deprecated in
+version 3.1.
+
=head1 SEE ALSO
L<bio(7)>, L<OPENSSL_LH_COMPFUNC(3)>