mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-02-23 14:42:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: update documentation to note removal of ERR_GET_FUNC()

Browse Source 
Reviewed-by: Nicola Tuveri <nic.tuv@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/16004)
This commit is contained in:
Pauli 2021-07-06 18:54:39 +10:00
parent 561e5cda7b
commit 4e20312ba6
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/man3/ERR_GET_LIB.pod
View File

@ -2,7 +2,7 @@
=head1 NAME
ERR_GET_LIB, ERR_GET_FUNC, ERR_GET_REASON, ERR_FATAL_ERROR
ERR_GET_LIB, ERR_GET_REASON, ERR_FATAL_ERROR
- get information from error codes
=head1 SYNOPSIS
@ -11,8 +11,6 @@ ERR_GET_LIB, ERR_GET_FUNC, ERR_GET_REASON, ERR_FATAL_ERROR
int ERR_GET_LIB(unsigned long e);
int ERR_GET_FUNC(unsigned long e);
int ERR_GET_REASON(unsigned long e);
int ERR_FATAL_ERROR(unsigned long e);
@ -20,7 +18,7 @@ ERR_GET_LIB, ERR_GET_FUNC, ERR_GET_REASON, ERR_FATAL_ERROR
=head1 DESCRIPTION
The error code returned by ERR_get_error() consists of a library
number, function code and reason code. ERR_GET_LIB(), ERR_GET_FUNC()
number, function code and reason code. ERR_GET_LIB()
and ERR_GET_REASON() can be used to extract these.
ERR_FATAL_ERROR() indicates whether a given error code is a fatal error.
@ -37,8 +35,7 @@ B<ERR_R_...> reason codes such as B<ERR_R_MALLOC_FAILURE> are globally
unique. However, when checking for sub-library specific reason codes,
be sure to also compare the library number.
ERR_GET_LIB(), ERR_GET_FUNC(), ERR_GET_REASON(), and ERR_FATAL_ERROR()
are macros.
ERR_GET_LIB(), ERR_GET_REASON(), and ERR_FATAL_ERROR() are macros.
=head1 RETURN VALUES
@ -52,8 +49,9 @@ L<ERR_get_error(3)>
=head1 HISTORY
ERR_GET_LIB(), ERR_GET_FUNC() and ERR_GET_REASON() are available in
all versions of OpenSSL.
ERR_GET_LIB() and ERR_GET_REASON() are available in all versions of OpenSSL.
ERR_GET_FUNC() was removed in OpenSSL 3.0.
=head1 COPYRIGHT