The branch master has been updated
via 43044ede54da4a4d5bd69e34cfb41ea03d7eb847 (commit)
from c727cddc9cb4c6c4cfe157727eb5bf7fe9c3fa21 (commit)
- Log -
commit 43044ede54da4a4d5bd69e34cfb41ea03d7eb847
Author: Omair Majid
Date: Wed Aug 18 14:57:57 2021 -0400
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
Reviewed-by: Paul Dale
Reviewed-by: Dmitry Belyavskiy
(Merged from https://github.com/openssl/openssl/pull/16353)
---
Summary of changes:
doc/man3/ERR_GET_LIB.pod | 13 ++---
1 file changed, 6 insertions(+), 7 deletions(-)
diff --git a/doc/man3/ERR_GET_LIB.pod b/doc/man3/ERR_GET_LIB.pod
index e388d32de2..f0779548e6 100644
--- a/doc/man3/ERR_GET_LIB.pod
+++ b/doc/man3/ERR_GET_LIB.pod
@@ -18,18 +18,17 @@ ERR_GET_LIB, 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()
+number 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.
-The library number and function code describe where the error
+The library number describes where the error
occurred, the reason code is the information about what went wrong.
-Each sub-library of OpenSSL has a unique library number; function and
-reason codes are unique within each sub-library. Note that different
-libraries may use the same value to signal different functions and
-reasons.
+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.
B reason codes such as B are globally
unique. However, when checking for sub-library specific reason codes,
@@ -39,7 +38,7 @@ ERR_GET_LIB(), ERR_GET_REASON(), and ERR_FATAL_ERROR() are
macros.
=head1 RETURN VALUES
-The library number, function code, reason code, and whether the error
+The library number, reason code, and whether the error
is fatal, respectively.
Starting with OpenSSL 3.0.0, the function code is always set to zero.
