]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Documenting lack of error codes stability
authorDmitry Belyavskiy <beldmit@gmail.com>
Tue, 10 Jan 2023 17:54:51 +0000 (18:54 +0100)
committerDmitry Belyavskiy <beldmit@gmail.com>
Mon, 16 Jan 2023 10:55:26 +0000 (11:55 +0100)
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)

doc/man3/ERR_GET_LIB.pod

index f0779548e6d4b98e4093257db85e51dd51151ed9..a35165b059f4fed965e167b46aee1ab555ed408c 100644 (file)
@@ -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)>