summaryrefslogtreecommitdiffstats
path: root/crypto/err
diff options
context:
space:
mode:
authorČestmír Kalina <ckalina@redhat.com>2022-12-02 16:53:57 +0100
committerTomas Mraz <tomas@openssl.org>2022-12-12 11:38:37 +0100
commit2ee2b74cc7b78d2fd3c15dab08adb76fee6249f9 (patch)
treea7ce16846a8bd5da066d6763cf689a39c50531fd /crypto/err
parentc3aed7e4e6f1960eaa43ecbea2178b82481887af (diff)
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)
Diffstat (limited to 'crypto/err')
-rw-r--r--crypto/err/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/crypto/err/README.md b/crypto/err/README.md
index 78085b3779..477dffa2ad 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.