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