diff options
author | Dmitry Belyavskiy <beldmit@gmail.com> | 2023-01-10 18:54:51 +0100 |
---|---|---|
committer | Dmitry Belyavskiy <beldmit@gmail.com> | 2023-01-16 11:55:26 +0100 |
commit | ae61bd34e676036f22e44e8184d1ba649a990619 (patch) | |
tree | 531c13d3e7152bbcf47c7f3229385e7033ce52e8 /doc | |
parent | 60c3d732b7b634290e4ec5d7ca6fb9b0a37592bf (diff) | |
download | openssl-new-ae61bd34e676036f22e44e8184d1ba649a990619.tar.gz |
Documenting lack of error codes stability
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20019)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/ERR_GET_LIB.pod | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/man3/ERR_GET_LIB.pod b/doc/man3/ERR_GET_LIB.pod index f0779548e6..a35165b059 100644 --- a/doc/man3/ERR_GET_LIB.pod +++ b/doc/man3/ERR_GET_LIB.pod @@ -42,6 +42,14 @@ 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. +=head1 NOTES + +Applications should not make control flow decisions based on specific error +codes. Error codes are subject to change at any time (even in patch releases of +OpenSSL). A particular error code can only be considered meaningful for control +flow decisions if it is explicitly documented as such. New failure codes may +still appear at any time. + =head1 SEE ALSO L<ERR_get_error(3)> |