summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2020-05-26 14:25:44 +0200
committerRichard Levitte <levitte@openssl.org>2020-05-29 08:26:10 +0200
commit329b2a2cde480fbfe1cf43bf8ecf1c75a16cf6bf (patch)
treea60689730431e38475c4bf1fd7d8bc1d13c54cae /doc
parentd561b84143f5e7956454090e15de0c5e1425ceac (diff)
DOCS: add openssl-core_numbers.h(7)
Reviewed-by: Shane Lontis <shane.lontis@oracle.com> (Merged from https://github.com/openssl/openssl/pull/11963)
Diffstat (limited to 'doc')
-rw-r--r--doc/man7/openssl-core_numbers.h.pod56
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/man7/openssl-core_numbers.h.pod b/doc/man7/openssl-core_numbers.h.pod
new file mode 100644
index 0000000000..d9bdcbc810
--- /dev/null
+++ b/doc/man7/openssl-core_numbers.h.pod
@@ -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