DOCS: add openssl-core_numbers.h(7)
authorRichard Levitte <levitte@openssl.org>
Tue, 26 May 2020 12:25:44 +0000 (14:25 +0200)
committerRichard Levitte <levitte@openssl.org>
Fri, 29 May 2020 06:26:10 +0000 (08:26 +0200)
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/11963)

doc/man7/openssl-core_numbers.h.pod [new file with mode: 0644]
util/missingcrypto.txt

diff --git a/doc/man7/openssl-core_numbers.h.pod b/doc/man7/openssl-core_numbers.h.pod
new file mode 100644 (file)
index 0000000..d9bdcbc
--- /dev/null
@@ -0,0 +1,56 @@
+=pod
+
+=head1 NAME
+
+openssl/core_numbers.h
+- OpenSSL provider dispatch numbers and function types
+
+=head1 SYNOPSIS
+
+ #include <openssl/core_numbers.h>
+
+=head1 DESCRIPTION
+
+The F<< <openssl/core_numbers.h> >> header defines all the operation
+numbers, dispatch numbers and provider interface function types
+currently available.
+
+The operation and dispatch numbers are represented with macros, which
+are named as follows:
+
+=over 4
+
+=item operation numbers
+
+These macros have the form C<OSSL_OP_I<opname>>.
+
+=item dipatch numbers
+
+These macros have the form C<OSSL_FUNC_I<opname>_I<funcname>>, where
+C<I<opname>> is the same as in the macro for the operation this
+function belongs to.
+
+=back
+
+With every dispatch number, there is an associated function type.
+
+For further information, please see the L<provider(7)>
+
+=head1 SEE ALSO
+
+L<provider(7)>
+
+=head1 HISTORY
+
+The types and macros described here were added in OpenSSL 3.0.
+
+=head1 COPYRIGHT
+
+Copyright 2020 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
index 6fba947..bc276a8 100644 (file)
@@ -1570,7 +1570,6 @@ i2v_ASN1_BIT_STRING(3)
 i2v_GENERAL_NAME(3)
 i2v_GENERAL_NAMES(3)
 o2i_ECPublicKey(3)
 i2v_GENERAL_NAME(3)
 i2v_GENERAL_NAMES(3)
 o2i_ECPublicKey(3)
-openssl-core_numbers.h(7)
 provider-kdf(7)
 v2i_ASN1_BIT_STRING(3)
 v2i_GENERAL_NAME(3)
 provider-kdf(7)
 v2i_ASN1_BIT_STRING(3)
 v2i_GENERAL_NAME(3)