1e1051a39Sopenharmony_ci=pod 2e1051a39Sopenharmony_ci 3e1051a39Sopenharmony_ci=head1 NAME 4e1051a39Sopenharmony_ci 5e1051a39Sopenharmony_ciOSSL_DEPRECATED, OSSL_DEPRECATED_FOR - General deprecation macros 6e1051a39Sopenharmony_ci 7e1051a39Sopenharmony_ci=head1 SYNOPSIS 8e1051a39Sopenharmony_ci 9e1051a39Sopenharmony_ci #include <openssl/macros.h> 10e1051a39Sopenharmony_ci 11e1051a39Sopenharmony_ci #define OSSL_DEPRECATED(since) 12e1051a39Sopenharmony_ci #define OSSL_DEPRECATED_FOR(since, msg) 13e1051a39Sopenharmony_ci 14e1051a39Sopenharmony_ci=head1 DESCRIPTION 15e1051a39Sopenharmony_ci 16e1051a39Sopenharmony_ciOSSL_DEPRECATED() implements the deprecated attribute if the compiler 17e1051a39Sopenharmony_cisupports it, otherwise it expands to nothing. It takes one argument 18e1051a39Sopenharmony_ciI<since> that should be set to the OpenSSL version where the symbol was 19e1051a39Sopenharmony_cideprecated, and will be displayed with the deprecation warning message, 20e1051a39Sopenharmony_cifor compilers that support user specified deprecation messages. 21e1051a39Sopenharmony_ci 22e1051a39Sopenharmony_ciOSSL_DEPRECATED_FOR() does the same as OSSL_DEPRECATED(), but also takes a 23e1051a39Sopenharmony_cisecond argument I<msg>, which is an additional text messages to be displayed 24e1051a39Sopenharmony_ciwith the deprecation warning along with the OpenSSL version number, for 25e1051a39Sopenharmony_cicompilers that support user specified deprecation messages. 26e1051a39Sopenharmony_ci 27e1051a39Sopenharmony_ciThese macros are used to define the version specific deprecation macros 28e1051a39Sopenharmony_cidescribed in L<deprecation(7)>. 29e1051a39Sopenharmony_ci 30e1051a39Sopenharmony_ci=begin comment 31e1051a39Sopenharmony_ci 32e1051a39Sopenharmony_ci[RETURN VALUES isn't relevant for these macros, but find-doc-nits demands 33e1051a39Sopenharmony_cithe presence of this section] 34e1051a39Sopenharmony_ci 35e1051a39Sopenharmony_ci=head1 RETURN VALUES 36e1051a39Sopenharmony_ci 37e1051a39Sopenharmony_ci[podchecker doesn't like empty sections] 38e1051a39Sopenharmony_ci 39e1051a39Sopenharmony_ci=end comment 40e1051a39Sopenharmony_ci 41e1051a39Sopenharmony_ci=head1 SEE ALSO 42e1051a39Sopenharmony_ci 43e1051a39Sopenharmony_ciL<deprecation(7)> 44e1051a39Sopenharmony_ci 45e1051a39Sopenharmony_ci=head1 COPYRIGHT 46e1051a39Sopenharmony_ci 47e1051a39Sopenharmony_ciCopyright 2020 The OpenSSL Project Authors. All Rights Reserved. 48e1051a39Sopenharmony_ci 49e1051a39Sopenharmony_ciLicensed under the Apache License 2.0 (the "License"). You may not use 50e1051a39Sopenharmony_cithis file except in compliance with the License. You can obtain a copy 51e1051a39Sopenharmony_ciin the file LICENSE in the source distribution or at 52e1051a39Sopenharmony_ciL<https://www.openssl.org/source/license.html>. 53e1051a39Sopenharmony_ci 54e1051a39Sopenharmony_ci=cut 55