All lh_stats functions were deprecated not just some
authorTomas Mraz <tomas@openssl.org>
Mon, 2 Oct 2023 13:43:22 +0000 (15:43 +0200)
committerPauli <pauli@openssl.org>
Tue, 3 Oct 2023 20:51:44 +0000 (07:51 +1100)
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22248)

doc/man3/OPENSSL_LH_stats.pod

index 5bc69674f8129be293117d77b547a0803ea3ce30..fb95928d8f200b36764f35e12915a90cd14900c3 100644 (file)
@@ -10,16 +10,16 @@ OPENSSL_LH_node_stats_bio, OPENSSL_LH_node_usage_stats_bio - LHASH statistics
 
  #include <openssl/lhash.h>
 
+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_node_stats(LHASH *table, FILE *out);
  void OPENSSL_LH_node_usage_stats(LHASH *table, FILE *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);
 
@@ -48,8 +48,7 @@ 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.
+These functions are deprecated and should no longer be used.
 
 =head1 RETURN VALUES
 
@@ -61,13 +60,14 @@ 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)>
 
+=head1 HISTORY
+
+These functions were deprecated in version 3.1.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.