Rename lh_xxx,sk_xxx tp OPENSSL_{LH,SK}_xxx
[openssl.git] / doc / crypto / lh_stats.pod
index 12b4a16f2fa9d09b6a62778554246dc6418c9160..bdc19b4e8436722a9ced1a0c9bc6e2732f4c029c 100644 (file)
@@ -2,20 +2,21 @@
 
 =head1 NAME
 
-lh_stats, lh_node_stats, lh_node_usage_stats, lh_stats_bio,
-lh_node_stats_bio, lh_node_usage_stats_bio - LHASH statistics
+OPENSSL_LH_stats, OPENSSL_LH_node_stats, OPENSSL_LH_node_usage_stats,
+OPENSSL_LH_stats_bio,
+OPENSSL_LH_node_stats_bio, OPENSSL_LH_node_usage_stats_bio - LHASH statistics
 
 =head1 SYNOPSIS
 
  #include <openssl/lhash.h>
 
- void lh_stats(LHASH *table, FILE *out);
- void lh_node_stats(LHASH *table, FILE *out);
- void lh_node_usage_stats(LHASH *table, FILE *out);
+ 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 lh_stats_bio(LHASH *table, BIO *out);
- void lh_node_stats_bio(LHASH *table, BIO *out);
- void lh_node_usage_stats_bio(LHASH *table, BIO *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);
 
 =head1 DESCRIPTION
 
@@ -24,14 +25,14 @@ accessing the hash table.  This is mostly a legacy of Eric Young
 writing this library for the reasons of implementing what looked like
 a nice algorithm rather than for a particular software product.
 
-lh_stats() prints out statistics on the size of the hash table, how
+OPENSSL_LH_stats() prints out statistics on the size of the hash table, how
 many entries are in it, and the number and result of calls to the
 routines in this library.
 
-lh_node_stats() prints the number of entries for each 'bucket' in the
+OPENSSL_LH_node_stats() prints the number of entries for each 'bucket' in the
 hash table.
 
-lh_node_usage_stats() prints out a short summary of the state of the
+OPENSSL_LH_node_usage_stats() prints out a short summary of the state of the
 hash table.  It prints the 'load' and the 'actual load'.  The load is
 the average number of data items per 'bucket' in the hash table.  The
 'actual load' is the average number of items per 'bucket', but only
@@ -40,7 +41,7 @@ average number of searches that will need to find an item in the hash
 table, while the 'load' is the average number that will be done to
 record a miss.
 
-lh_stats_bio(), lh_node_stats_bio() and lh_node_usage_stats_bio()
+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>.
 
 =head1 RETURN VALUES