openssl/doc/man3/OSSL_CORE_MAKE_FUNC.pod
Matt Caswell d2f82495a2 Cleanup the missing*.txt files
One macro existed that was added since 1.1.1 and was undocumented. This
had been added to missingmacro.txt. This is the wrong approach and so
has been removed from there.

There were some entries in missingcrypto.txt that don't exist as functions
at all. There were also some which were in fact documented.

Additionally 2 entries from missingcrypto.txt have been moved to
missingmacro.txt. These entries existed in 1.1.1 and were undocumented. In
master they have been deprecated and compatibility macros for them
implemented. The replacement functions have been documented.

An entry in missingcrypto111.txt was not in alphabetical order (and was
also) duplicated, but the equivalent entry in missingcrypto.txt was in the
correct place. This has been corrected to make comparisons between the files
easier.

Finally a function has been added to missingcrypto111.txt. This function
did exist in 1.1.1 and was undocumented. Its unclear why this wasn't in
missingcrypto111.txt to start with.

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15333)
2021-05-21 11:03:37 +02:00

44 lines
933 B
Plaintext

=pod
=head1 NAME
OSSL_CORE_MAKE_FUNC,
SSL_OP_BIT,
EXT_UTF8STRING
- OpenSSL reserved symbols
=head1 SYNOPSIS
#include <openssl/core_dispatch.h>
#define OSSL_CORE_MAKE_FUNC(type,name,args)
#define SSL_OP_BIT(n)
#define EXT_UTF8STRING(nid)
=head1 DESCRIPTION
There are certain macros that may appear in OpenSSL header files that are
reserved for internal use. They should not be used by applications or assumed
to exist.
All the macros listed in the synopsis above are reserved.
=head1 RETURN VALUES
Not applicable.
=head1 HISTORY
The macros described here were added in OpenSSL 3.0.
=head1 COPYRIGHT
Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut