From: Čestmír Kalina <ckalina@redhat.com>
Date: Fri, 2 Dec 2022 15:53:57 +0000 (+0100)
Subject: crypto/err: expand on error code generation
X-Git-Tag: openssl-3.2.0-alpha1~1595
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2ee2b74cc7b78d2fd3c15dab08adb76fee6249f9;p=thirdparty%2Fopenssl.git

crypto/err: expand on error code generation

Signed-off-by: Čestmír Kalina <ckalina@redhat.com>

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19823)
---

diff --git a/crypto/err/README.md b/crypto/err/README.md
index 78085b37799..477dffa2ad3 100644
--- a/crypto/err/README.md
+++ b/crypto/err/README.md
@@ -42,3 +42,14 @@ The generated C error code file `xxx_err.c` will load the header
 files `stdio.h`, `openssl/err.h` and `openssl/xxx.h` so the
 header file must load any additional header files containing any
 definitions it uses.
+
+Adding new error codes
+======================
+
+Instead of manually adding error codes into `crypto/err/openssl.txt`,
+it is recommended to leverage `make update` for error code generation.
+The target will process relevant sources and generate error codes for
+any *used* error codes.
+
+If an error code is added manually into `crypto/err/openssl.txt`,
+subsequent `make update` has no effect.