Add documentation for the macro OPENSSL_VERSION_PREREQ

This macro was added since 1.1.1 but had no associated documentation.

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14232)

diff --git a/doc/man3/OpenSSL_version.pod b/doc/man3/OpenSSL_version.pod
index a4ef1cfbaffd635a7e196c394a48e18df6aceb20..e28a35e73a727e3d3713b10c033bc7dd9a42a35a 100644 (file)
--- a/doc/man3/OpenSSL_version.pod
+++ b/doc/man3/OpenSSL_version.pod
@@ -4,10 +4,10 @@
 
 OPENSSL_VERSION_MAJOR, OPENSSL_VERSION_MINOR, OPENSSL_VERSION_PATCH,
 OPENSSL_VERSION_PRE_RELEASE, OPENSSL_VERSION_BUILD_METADATA,
-OPENSSL_VERSION_TEXT,
-OPENSSL_version_major, OPENSSL_version_minor, OPENSSL_version_patch,
-OPENSSL_version_pre_release, OPENSSL_version_build_metadata, OpenSSL_version,
-OPENSSL_VERSION_NUMBER, OpenSSL_version_num, OPENSSL_info
+OPENSSL_VERSION_TEXT, OPENSSL_VERSION_PREREQ, OPENSSL_version_major,
+OPENSSL_version_minor, OPENSSL_version_patch, OPENSSL_version_pre_release,
+OPENSSL_version_build_metadata, OpenSSL_version, OPENSSL_VERSION_NUMBER,
+OpenSSL_version_num, OPENSSL_info
 - get OpenSSL version number and other information
 
 =head1 SYNOPSIS
@@ -24,6 +24,8 @@ OPENSSL_VERSION_NUMBER, OpenSSL_version_num, OPENSSL_info
 
  #define OPENSSL_VERSION_TEXT "OpenSSL x.y.z xx XXX xxxx"
 
+ #define OPENSSL_VERSION_PREREQ(maj,min)
+
  #include <openssl/crypto.h>
 
  unsigned int OPENSSL_version_major(void);
@@ -73,6 +75,12 @@ B<OPENSSL_VERSION_TEXT> is a convenience macro to get a full descriptive
 version text, which includes B<OPENSSL_FULL_VERSION_STR> and the release
 date.
 
+B<OPENSSL_VERSION_PREREQ> is a useful macro for checking whether the OpenSSL
+version for the headers in use is at least at the given pre-requisite major
+(B<maj>) and minor (B<min>) number or not. It will evaluate to true if the
+header version number (B<OPENSSL_VERSION_MAJOR>.B<OPENSSL_VERSION_MINOR>) is
+greater than or equal to B<maj>.B<min>.
+
 =head2 Functions
 
 OPENSSL_version_major(), OPENSSL_version_minor(), OPENSSL_version_patch(),

diff --git a/util/missingmacro.txt b/util/missingmacro.txt
index 4cad414f3af5bb59353d9f165abe4498af338f9e..7bdb96c0d45f5c315bfc2908ae844f781afdc1ab 100644 (file)
--- a/util/missingmacro.txt
+++ b/util/missingmacro.txt
@@ -99,7 +99,6 @@ PEM_write_bio_OCSP_REQUEST(3)
 PEM_write_bio_OCSP_RESPONSE(3)
 ASN1_BIT_STRING_digest(3)
 OCSP_CERTSTATUS_dup(3)
-OPENSSL_VERSION_PREREQ(3)
 OSSL_PARAM_DEFN(3)
 OSSL_PARAM_SIZED_int(3)
 OSSL_PARAM_SIZED_uint(3)

diff --git a/util/other.syms b/util/other.syms
index 670ba789381aa4deaff0e5ccec83368f8fc488d7..3d84ea777285e67bad908fa86cd3049bf3f569e6 100644 (file)
--- a/util/other.syms
+++ b/util/other.syms
@@ -348,6 +348,7 @@ OPENSSL_VERSION_MINOR                   define
 OPENSSL_VERSION_NUMBER                  define deprecated 3.0.0
 OPENSSL_VERSION_PATCH                   define
 OPENSSL_VERSION_PRE_RELEASE             define
+OPENSSL_VERSION_PREREQ                  define
 OPENSSL_VERSION_BUILD_METADATA          define
 OPENSSL_VERSION_PRE_RELEASE_STR         define
 OPENSSL_VERSION_BUILD_METADATA_STR      define