diff options
author | schwarze <> | 2016-12-16 08:53:30 +0000 |
---|---|---|
committer | schwarze <> | 2016-12-16 08:53:30 +0000 |
commit | 01f49d5c8dc04c7108d0540dcc1d0134b5ed781b (patch) | |
tree | ad8d41468de535b6f44dd11efad2515a2fc19154 /src/lib | |
parent | c2919f6581a728e915a59134890fbf70c0d132ae (diff) | |
download | openbsd-01f49d5c8dc04c7108d0540dcc1d0134b5ed781b.tar.gz openbsd-01f49d5c8dc04c7108d0540dcc1d0134b5ed781b.tar.bz2 openbsd-01f49d5c8dc04c7108d0540dcc1d0134b5ed781b.zip |
Document ERR_FATAL_ERROR(3), tweaked by me.
OpenSSL commit 036ba500f7886ca2e7231549fa574ec2cdd45cef
Author: Benjamin Kaduk <bkaduk@akamai.com>
Date: Thu Dec 8 12:01:31 2016 -0600
Diffstat (limited to 'src/lib')
-rw-r--r-- | src/lib/libcrypto/man/ERR_GET_LIB.3 | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/src/lib/libcrypto/man/ERR_GET_LIB.3 b/src/lib/libcrypto/man/ERR_GET_LIB.3 index d67e8bdde6..03f56c09f6 100644 --- a/src/lib/libcrypto/man/ERR_GET_LIB.3 +++ b/src/lib/libcrypto/man/ERR_GET_LIB.3 | |||
@@ -1,5 +1,5 @@ | |||
1 | .\" $OpenBSD: ERR_GET_LIB.3,v 1.4 2016/11/23 17:59:29 schwarze Exp $ | 1 | .\" $OpenBSD: ERR_GET_LIB.3,v 1.5 2016/12/16 08:53:30 schwarze Exp $ |
2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | 2 | .\" OpenSSL doc/man3/ERR_GET_LIB.pod 3dfda1a6 Dec 12 11:14:40 2016 -0500 |
3 | .\" | 3 | .\" |
4 | .\" This file was written by Ulf Moeller <ulf@openssl.org>. | 4 | .\" This file was written by Ulf Moeller <ulf@openssl.org>. |
5 | .\" Copyright (c) 2000 The OpenSSL Project. All rights reserved. | 5 | .\" Copyright (c) 2000 The OpenSSL Project. All rights reserved. |
@@ -48,13 +48,14 @@ | |||
48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
50 | .\" | 50 | .\" |
51 | .Dd $Mdocdate: November 23 2016 $ | 51 | .Dd $Mdocdate: December 16 2016 $ |
52 | .Dt ERR_GET_LIB 3 | 52 | .Dt ERR_GET_LIB 3 |
53 | .Os | 53 | .Os |
54 | .Sh NAME | 54 | .Sh NAME |
55 | .Nm ERR_GET_LIB , | 55 | .Nm ERR_GET_LIB , |
56 | .Nm ERR_GET_FUNC , | 56 | .Nm ERR_GET_FUNC , |
57 | .Nm ERR_GET_REASON | 57 | .Nm ERR_GET_REASON , |
58 | .Nm ERR_FATAL_ERROR | ||
58 | .Nd get library, function and reason codes for OpenSSL errors | 59 | .Nd get library, function and reason codes for OpenSSL errors |
59 | .Sh SYNOPSIS | 60 | .Sh SYNOPSIS |
60 | .In openssl/err.h | 61 | .In openssl/err.h |
@@ -70,6 +71,10 @@ | |||
70 | .Fo ERR_GET_REASON | 71 | .Fo ERR_GET_REASON |
71 | .Fa "unsigned long e" | 72 | .Fa "unsigned long e" |
72 | .Fc | 73 | .Fc |
74 | .Ft int | ||
75 | .Fo ERR_FATAL_ERROR | ||
76 | .Fa "unsigned long e" | ||
77 | .Fc | ||
73 | .Sh DESCRIPTION | 78 | .Sh DESCRIPTION |
74 | The error code returned by | 79 | The error code returned by |
75 | .Xr ERR_get_error 3 | 80 | .Xr ERR_get_error 3 |
@@ -95,13 +100,19 @@ are globally unique. | |||
95 | However, when checking for sub-library specific reason codes, be sure to | 100 | However, when checking for sub-library specific reason codes, be sure to |
96 | also compare the library number. | 101 | also compare the library number. |
97 | .Pp | 102 | .Pp |
103 | .Fn ERR_FATAL_ERROR | ||
104 | indicates whether a given error code is a fatal error. | ||
105 | .Pp | ||
106 | These functions are implemented as macros. | ||
107 | .Sh RETURN VALUES | ||
98 | .Fn ERR_GET_LIB , | 108 | .Fn ERR_GET_LIB , |
99 | .Fn ERR_GET_FUNC , | 109 | .Fn ERR_GET_FUNC , |
100 | and | 110 | and |
101 | .Fn ERR_GET_REASON | 111 | .Fn ERR_GET_REASON |
102 | are macros. | 112 | return the library number, function code, and reason code, respectively. |
103 | .Sh RETURN VALUES | 113 | .Pp |
104 | The library number, function code, and reason code, respectively. | 114 | .Fn ERR_FATAL_ERROR |
115 | returns non-zero if the error is fatal or 0 otherwise. | ||
105 | .Sh SEE ALSO | 116 | .Sh SEE ALSO |
106 | .Xr ERR 3 , | 117 | .Xr ERR 3 , |
107 | .Xr ERR_get_error 3 | 118 | .Xr ERR_get_error 3 |