]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
crypto/err: expand on error code generation
authorČestmír Kalina <ckalina@redhat.com>
Fri, 2 Dec 2022 15:53:57 +0000 (16:53 +0100)
committerTomas Mraz <tomas@openssl.org>
Mon, 12 Dec 2022 10:38:37 +0000 (11:38 +0100)
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)

crypto/err/README.md

index 78085b37799d74ca695ef44f61aa10a2764d5358..477dffa2ad3251c8024a6bc41e96c831f9024189 100644 (file)
@@ -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.