diff options
| author | Matt Caswell <matt@openssl.org> | 2022-02-22 11:49:04 +0000 |
|---|---|---|
| committer | Pauli <pauli@openssl.org> | 2022-02-24 10:01:59 +1100 |
| commit | 42659159f4d4a8c16a0e9b089d40a5831b60cbb6 (patch) | |
| tree | 5c78a8dd9306906096645a1cf9976ebab828c1c9 /doc | |
| parent | 0bc2fda3d3b76bd07243aef3eb7f824da3820b2d (diff) | |
Undeprecate OPENSSL_VERSION_NUMBER and OpenSSL_version_num()
This macro and function were deprecated in the documentation but not in
the source.
Following an OTC vote the deprecation has been removed from the
documentation.
See https://github.com/openssl/technical-policies/issues/26
Fixes #17517
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/17750)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/OpenSSL_version.pod | 52 |
1 files changed, 20 insertions, 32 deletions
diff --git a/doc/man3/OpenSSL_version.pod b/doc/man3/OpenSSL_version.pod index 034bd718fe..a0a9021431 100644 --- a/doc/man3/OpenSSL_version.pod +++ b/doc/man3/OpenSSL_version.pod @@ -38,8 +38,6 @@ OpenSSL_version_num, OPENSSL_info const char *OPENSSL_info(int t); -Deprecated: - /* from openssl/opensslv.h */ #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnL @@ -81,6 +79,25 @@ version for the headers in use is at least at the given pre-requisite major header version number (B<OPENSSL_VERSION_MAJOR>.B<OPENSSL_VERSION_MINOR>) is greater than or equal to B<maj>.B<min>. +B<OPENSSL_VERSION_NUMBER> is a combination of the major, minor and +patch version into a single integer 0xMNN00PP0L, where: + +=over 4 + +=item M + +is the number from B<OPENSSL_VERSION_MAJOR>, in hexadecimal notation + +=item NN + +is the number from B<OPENSSL_VERSION_MINOR>, in hexadecimal notation + +=item PP + +is the number from B<OPENSSL_VERSION_PATCH>, in hexadecimal notation + +=back + =head2 Functions OPENSSL_version_major(), OPENSSL_version_minor(), OPENSSL_version_patch(), @@ -198,35 +215,6 @@ For x86 the string looks like C<OPENSSL_ia32cap=0x123:0x456>. For an unknown I<t>, NULL is returned. -=head1 BACKWARD COMPATIBILITY - -For compatibility, some older macros and functions are retained or -synthesised. -They are all considered deprecated. - -=head2 Macros - -B<OPENSSL_VERSION_NUMBER> is a combination of the major, minor and -patch version into a single integer 0xMNN00PP0L, where: - -=over 4 - -=item M - -is the number from B<OPENSSL_VERSION_MAJOR>, in hexadecimal notation - -=item NN - -is the number from B<OPENSSL_VERSION_MINOR>, in hexadecimal notation - -=item PP - -is the number from B<OPENSSL_VERSION_PATCH>, in hexadecimal notation - -=back - -=head2 Functions - OpenSSL_version_num() returns the value of B<OPENSSL_VERSION_NUMBER>. =head1 RETURN VALUES @@ -248,7 +236,7 @@ L<crypto(7)> =head1 HISTORY The macros and functions described here were added in OpenSSL 3.0, -with the exception of the L</BACKWARD COMPATIBILITY> ones. +except for OPENSSL_VERSION_NUMBER and OpenSSL_version_num(). =head1 COPYRIGHT |