diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/internal/man7/deprecation.pod | 1 | ||||
| -rw-r--r-- | doc/man3/OPENSSL_LH_COMPFUNC.pod | 19 | ||||
| -rw-r--r-- | doc/man3/OPENSSL_LH_stats.pod | 15 | ||||
| -rw-r--r-- | doc/man7/migration_guide.pod | 2 |
4 files changed, 32 insertions, 5 deletions
diff --git a/doc/internal/man7/deprecation.pod b/doc/internal/man7/deprecation.pod index 13a4b059a0..de34c30fa2 100644 --- a/doc/internal/man7/deprecation.pod +++ b/doc/internal/man7/deprecation.pod @@ -2,6 +2,7 @@ =head1 NAME +OPENSSL_NO_DEPRECATED_3_1, OSSL_DEPRECATEDIN_3_1, OPENSSL_NO_DEPRECATED_3_0, OSSL_DEPRECATEDIN_3_0, OPENSSL_NO_DEPRECATED_1_1_1, OSSL_DEPRECATEDIN_1_1_1, OPENSSL_NO_DEPRECATED_1_1_0, OSSL_DEPRECATEDIN_1_1_0, diff --git a/doc/man3/OPENSSL_LH_COMPFUNC.pod b/doc/man3/OPENSSL_LH_COMPFUNC.pod index d3bb272c4a..ba128404b3 100644 --- a/doc/man3/OPENSSL_LH_COMPFUNC.pod +++ b/doc/man3/OPENSSL_LH_COMPFUNC.pod @@ -2,7 +2,7 @@ =head1 NAME -LHASH, DECLARE_LHASH_OF, +LHASH, LHASH_OF, DEFINE_LHASH_OF_EX, DEFINE_LHASH_OF, OPENSSL_LH_COMPFUNC, OPENSSL_LH_HASHFUNC, OPENSSL_LH_DOALL_FUNC, LHASH_DOALL_ARG_FN_TYPE, IMPLEMENT_LHASH_HASH_FN, IMPLEMENT_LHASH_COMP_FN, @@ -20,7 +20,9 @@ OPENSSL_LH_doall, OPENSSL_LH_doall_arg, OPENSSL_LH_error #include <openssl/lhash.h> - DECLARE_LHASH_OF(TYPE); + LHASH_OF(TYPE) + + DEFINE_LHASH_OF_EX(TYPE); LHASH_OF(TYPE) *lh_TYPE_new(OPENSSL_LH_HASHFUNC hash, OPENSSL_LH_COMPFUNC compare); void lh_TYPE_free(LHASH_OF(TYPE) *table); @@ -54,6 +56,10 @@ OPENSSL_LH_doall, OPENSSL_LH_doall_arg, OPENSSL_LH_error int OPENSSL_LH_error(OPENSSL_LHASH *lh); +The following macro is deprecated: + + DEFINE_LHASH_OF(TYPE); + =head1 DESCRIPTION This library implements type-checked dynamic hash tables. The hash @@ -61,6 +67,12 @@ table entries can be arbitrary structures. Usually they consist of key and value fields. In the description here, B<I<TYPE>> is used a placeholder for any of the OpenSSL datatypes, such as I<SSL_SESSION>. +To define a new type-checked dynamic hash table, use B<DEFINE_LHASH_OF_EX>(). +B<DEFINE_LHASH_OF>() was previously used for this purpose, but is now +deprecated. The B<DEFINE_LHASH_OF_EX>() macro provides all functionality of +B<DEFINE_LHASH_OF>() except for certain deprecated statistics functions (see +OPENSSL_LH_stats(3)). + B<lh_I<TYPE>_new>() creates a new B<LHASH_OF>(B<I<TYPE>>) structure to store arbitrary data entries, and specifies the 'hash' and 'compare' callbacks to be used in organising the table's entries. The I<hash> @@ -268,6 +280,9 @@ L<OPENSSL_LH_stats(3)> In OpenSSL 1.0.0, the lhash interface was revamped for better type checking. +In OpenSSL 3.1, B<DEFINE_LHASH_OF_EX>() was introduced and B<DEFINE_LHASH_OF>() +was deprecated. + =head1 COPYRIGHT Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved. 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)> diff --git a/doc/man7/migration_guide.pod b/doc/man7/migration_guide.pod index bdbecf1528..a32eb7dddc 100644 --- a/doc/man7/migration_guide.pod +++ b/doc/man7/migration_guide.pod @@ -329,7 +329,7 @@ This code is now always set to zero. Related functions are deprecated. =head4 STACK and HASH macros have been cleaned up The type-safe wrappers are declared everywhere and implemented once. -See L<DEFINE_STACK_OF(3)> and L<DECLARE_LHASH_OF(3)>. +See L<DEFINE_STACK_OF(3)> and L<DEFINE_LHASH_OF_EX(3)>. =head4 The RAND_DRBG subsystem has been removed |