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