openssl/crypto/err
Richard Levitte d5f9166bac Move e_os.h to include/internal
Including e_os.h with a path from a header file doesn't work well on
certain exotic platform.  It simply fails to build.

Since we don't seem to be able to stop ourselves, the better move is
to move e_os.h to an include directory that's part of the inclusion
path given to the compiler.

Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/17641)
2022-02-05 05:31:09 +01:00
..
build.info ERR: Move ERR_set_mark(), ERR_pop_to_mark() and ERR_clear_last_mark() 2022-01-21 14:44:16 +01:00
err_all_legacy.c Update copyright year 2021-06-17 13:24:59 +01:00
err_all.c
err_blocks.c err: remove TODOs 2021-06-02 16:30:15 +10:00
err_local.h err: clear flags better when clearing errors. 2021-06-10 18:11:45 +10:00
err_mark.c ERR: Move ERR_set_mark(), ERR_pop_to_mark() and ERR_clear_last_mark() 2022-01-21 14:44:16 +01:00
err_prn.c err: remove TODOs 2021-06-02 16:30:15 +10:00
err.c Move e_os.h to include/internal 2022-02-05 05:31:09 +01:00
openssl.ec
openssl.txt err: add additional errors 2022-01-12 20:10:21 +11:00
README.md

Adding new libraries

When adding a new sub-library to OpenSSL, assign it a library number ERR_LIB_XXX, define a macro XXXerr() (both in err.h), add its name to ERR_str_libraries[] (in crypto/err/err.c), and add ERR_load_XXX_strings() to the ERR_load_crypto_strings() function (in crypto/err/err_all.c). Finally, add an entry:

L      XXX     xxx.h   xxx_err.c

to crypto/err/openssl.ec, and add xxx_err.c to the Makefile. Running make errors will then generate a file xxx_err.c, and add all error codes used in the library to xxx.h.

Additionally the library include file must have a certain form. Typically it will initially look like this:

#ifndef HEADER_XXX_H
#define HEADER_XXX_H

#ifdef __cplusplus
extern "C" {
#endif

/* Include files */

#include <openssl/bio.h>
#include <openssl/x509.h>

/* Macros, structures and function prototypes */


/* BEGIN ERROR CODES */

The BEGIN ERROR CODES sequence is used by the error code generation script as the point to place new error codes, any text after this point will be overwritten when make errors is run. The closing #endif etc will be automatically added by the script.

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.