mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2024-12-27 06:21:43 +08:00
Code Issues Packages Projects Releases Wiki Activity
cd715b7e7f
openssl/doc/man3/ERR_GET_LIB.pod

65 lines
1.7 KiB
Plaintext
Raw Normal View History

Document ERR library.
2000-02-01 09:37:00 +08:00
=pod
=head1 NAME
doc: update documentation to note removal of ERR_GET_FUNC() Reviewed-by: Nicola Tuveri <nic.tuv@gmail.com> (Merged from https://github.com/openssl/openssl/pull/16004)
2021-07-06 16:54:39 +08:00
ERR_GET_LIB, ERR_GET_REASON, ERR_FATAL_ERROR
Fix various doc nits. find-doc-nits warns if you don't give a "what to do flag" Don't use regexps for section names, just strings: More consistency. Rename "COMMAND OPTIONS" to OPTIONS. Fix a couple of other nit-level things. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2076)
2016-12-13 00:14:40 +08:00
- get information from error codes
Document ERR library.
2000-02-01 09:37:00 +08:00
=head1 SYNOPSIS
#include <openssl/err.h>
int ERR_GET_LIB(unsigned long e);
int ERR_GET_REASON(unsigned long e);
Restore the ERR_FATAL_ERROR() macro Commit 0cd0a820abc6124cf8e176fa92d620a2abf9e419 removed this macro along with many unused function and reason codes; ERR_FATAL_ERROR() was not used in the tree, but did have external consumers. Add it back to restore the API compatibility and avoid breaking applications for no internal benefit. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2049)
2016-12-09 02:01:31 +08:00
int ERR_FATAL_ERROR(unsigned long e);
Document ERR library.
2000-02-01 09:37:00 +08:00
=head1 DESCRIPTION
The error code returned by ERR_get_error() consists of a library
Fix documentation referring to 'function code' ERR_GET_FUNC was removed, so remove references to 'function code' as well from docs. CLA: trivial Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> (Merged from https://github.com/openssl/openssl/pull/16353)
2021-08-19 02:57:57 +08:00
number and reason code. ERR_GET_LIB()
Document ERR library.
2000-02-01 09:37:00 +08:00
and ERR_GET_REASON() can be used to extract these.
Restore the ERR_FATAL_ERROR() macro Commit 0cd0a820abc6124cf8e176fa92d620a2abf9e419 removed this macro along with many unused function and reason codes; ERR_FATAL_ERROR() was not used in the tree, but did have external consumers. Add it back to restore the API compatibility and avoid breaking applications for no internal benefit. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2049)
2016-12-09 02:01:31 +08:00
ERR_FATAL_ERROR() indicates whether a given error code is a fatal error.
Fix documentation referring to 'function code' ERR_GET_FUNC was removed, so remove references to 'function code' as well from docs. CLA: trivial Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> (Merged from https://github.com/openssl/openssl/pull/16353)
2021-08-19 02:57:57 +08:00
The library number describes where the error
Document ERR library.
2000-02-01 09:37:00 +08:00
occurred, the reason code is the information about what went wrong.
Fix documentation referring to 'function code' ERR_GET_FUNC was removed, so remove references to 'function code' as well from docs. CLA: trivial Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> (Merged from https://github.com/openssl/openssl/pull/16353)
2021-08-19 02:57:57 +08:00
Each sub-library of OpenSSL has a unique library number; the
reason code is unique within each sub-library. Note that different
libraries may use the same value to signal different reasons.
Document ERR library.
2000-02-01 09:37:00 +08:00
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.
doc: update documentation to note removal of ERR_GET_FUNC() Reviewed-by: Nicola Tuveri <nic.tuv@gmail.com> (Merged from https://github.com/openssl/openssl/pull/16004)
2021-07-06 16:54:39 +08:00
ERR_GET_LIB(), ERR_GET_REASON(), and ERR_FATAL_ERROR() are macros.
Document ERR library.
2000-02-01 09:37:00 +08:00
=head1 RETURN VALUES
Fix documentation referring to 'function code' ERR_GET_FUNC was removed, so remove references to 'function code' as well from docs. CLA: trivial Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> (Merged from https://github.com/openssl/openssl/pull/16353)
2021-08-19 02:57:57 +08:00
The library number, reason code, and whether the error
Restore the ERR_FATAL_ERROR() macro Commit 0cd0a820abc6124cf8e176fa92d620a2abf9e419 removed this macro along with many unused function and reason codes; ERR_FATAL_ERROR() was not used in the tree, but did have external consumers. Add it back to restore the API compatibility and avoid breaking applications for no internal benefit. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2049)
2016-12-09 02:01:31 +08:00
is fatal, respectively.
Remove function name from errors Deprecate all xxx_F_ defines. Removed some places that tested for a specific function. Use empty field for the function names in output. Update documentation. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9058)
2019-06-01 01:52:45 +08:00
Starting with OpenSSL 3.0.0, the function code is always set to zero.
Document ERR library.
2000-02-01 09:37:00 +08:00
=head1 SEE ALSO
Remove ref to err(7), update copyright. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2825)
2017-03-02 23:07:21 +08:00
L<ERR_get_error(3)>
Document ERR library.
2000-02-01 09:37:00 +08:00
=head1 HISTORY
doc: update documentation to note removal of ERR_GET_FUNC() Reviewed-by: Nicola Tuveri <nic.tuv@gmail.com> (Merged from https://github.com/openssl/openssl/pull/16004)
2021-07-06 16:54:39 +08:00
ERR_GET_LIB() and ERR_GET_REASON() are available in all versions of OpenSSL.
ERR_GET_FUNC() was removed in OpenSSL 3.0.
Document ERR library.
2000-02-01 09:37:00 +08:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
=head1 COPYRIGHT
Update copyright year Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/16176)
2021-07-29 22:41:35 +08:00
Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
Following the license change, modify the boilerplates in doc/man3/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
2018-12-06 21:04:44 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
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
Reference in New Issue Copy Permalink