From ae61bd34e676036f22e44e8184d1ba649a990619 Mon Sep 17 00:00:00 2001 From: Dmitry Belyavskiy Date: Tue, 10 Jan 2023 18:54:51 +0100 Subject: [PATCH] Documenting lack of error codes stability Reviewed-by: Hugo Landau Reviewed-by: Matt Caswell Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/20019) --- doc/man3/ERR_GET_LIB.pod | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/man3/ERR_GET_LIB.pod b/doc/man3/ERR_GET_LIB.pod index f0779548e6d..a35165b059f 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 -- 2.47.2