summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2021-06-30 06:31:58 +0200
committerRichard Levitte <levitte@openssl.org>2021-07-01 09:19:54 +0200
commit025312431db8c5cf0c16e1043987a7f0f9e3bf87 (patch)
treeec0317bf0fde4ab8bbc634fda7fba4009724b525 /doc
parenta5a4dac988c536bb021c4145ebba88e1507834f8 (diff)
downloadopenssl-new-025312431db8c5cf0c16e1043987a7f0f9e3bf87.tar.gz
DOC: clarify OPENSSL_API_COMPAT
Fixes #15928 Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/15956)
Diffstat (limited to 'doc')
-rw-r--r--doc/man7/openssl_user_macros.pod.in6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/man7/openssl_user_macros.pod.in b/doc/man7/openssl_user_macros.pod.in
index 33969e2476..ec99da594f 100644
--- a/doc/man7/openssl_user_macros.pod.in
+++ b/doc/man7/openssl_user_macros.pod.in
@@ -74,16 +74,18 @@ minor and patch components of the version number. For example:
=back
-If not set, this macro will default to
+If B<OPENSSL_API_COMPAT> is undefined, this default value is used in its
+place:
C<{- join('', map { my @x = split /=/,$_; $x[1] }
grep /^OPENSSL_CONFIGURED_API=/, @{$config{openssl_api_defines} // []})
|| '0x00000000L'
- -}>.
+ -}>
=item B<OPENSSL_NO_DEPRECATED>
If this macro is defined, all deprecated public symbols in all OpenSSL
versions up to and including the version given by B<OPENSSL_API_COMPAT>
+(or the default value given above, when B<OPENSSL_API_COMPAT> isn't defined)
will be hidden.
=back